{"items":[{"type":"link","label":"Kantata OX API Documentation","link":"/kantata/specification","routeSlug":"/kantata/specification","content":{"contentType":"overview","meta":{"name":"Kantata OX API Documentation"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"Download OpenAPI Description","url":"https://app.mavenlink.com/oas/specification"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://knowledge.kantata.com/hc/en-us","url":"https://knowledge.kantata.com/hc/en-us"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"COPYRIGHT © 2026 Kantata, Inc.","url":"https://www.kantata.com/terms-of-use"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://www.kantata.com/terms-of-use"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"python","title":"Python","lang":"Python"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"go","title":"Go","lang":"Go"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Kantata OX API Documentation (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Kantata OX's API provides access to the majority of Kantata OX's data model. The API authenticates requests using OAuth2 tokens and exists primarily to allow scripts and 3rd-party applications to access and manage Kantata OX data on behalf of Kantata OX users."}],"sectionId":"/kantata/specification"}],"sectionId":"/kantata/specification"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/schema"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests must be sent via HTTPS and can be in either JSON or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://stackoverflow.com/a/950198"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails structured x-www-form-urlencoded"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Responses will always be returned in JSON format. Dates and times are returned as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://www.w3.org/TR/NOTE-datetime"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" formatted strings. All requests to the API must have URLs relative to the base API URL:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"https://api.mavenlink.com/api/v1/\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"https://api.mavenlink.com/api/v1/\n"},"children":[]}]}]}],"sectionId":"/kantata/specification/section/schema"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All requests to the Kantata OX API must be authenticated with an OAuth bearer token. See the application workflow for details on how to register an application with Kantata OX and obtain OAuth bearer tokens."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, set the header's value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". So, if your token was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your HTTP request would include the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer abc123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, authenticating a request using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would mean running a command similar to this one:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -H \"Authorization: Bearer abc123\" \"https://api.mavenlink.com/api/v1/workspaces.json\"\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -H \"Authorization: Bearer abc123\" \"https://api.mavenlink.com/api/v1/workspaces.json\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All requests to the Kantata OX API require an Authorization header. For brevity, future API request examples in this documentation will not include the example Authorization header parameter."},"children":[]}]}]}]}],"sectionId":"/kantata/specification/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/oauth-2.0"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://oauth.net/2/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides an evolving, standardized inter-application authentication workflow for the Web. To build an application that interacts with Kantata OX on behalf of your users, you will need to register your application, and then obtain an OAuth token for each of your users."},"children":[]}]}]}]}],"sectionId":"/kantata/specification/section/oauth-2.0"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/registering-your-application"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registering your application"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register and manage OAuth2 applications that can connect to Kantata OX at the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.mavenlink.com/oauth/applications"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page as a Kantata OX account administrator. You'll need a paid Kantata OX account in order to register applications with us. Applications have a name and a callback URL for OAuth2."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you only want to use the Kantata OX API for yourself, or as a backend connector, you must still register an Application, but then you can get an OAuth token for yourself on the Application's page. If you want your application to be able to use the Kantata OX API on behalf of other users, read the next section."},"children":[]}]}]}]}],"sectionId":"/kantata/specification/section/registering-your-application"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/obtaining-tokens-for-users"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtaining tokens for users"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every request to the Kantata OX API must be accompanied by a valid OAuth token, indicating that your application has been authorized by the Kantata OX user in question. When you register an application with us, we'll provide you with a secret key. That key is unique to your application, and shouldn't be shared with anyone else. Treat it like a password. You'll need it to request user tokens."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authorize your application for Kantata OX API access and obtain a user token, follow the below steps for each Kantata OX user:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you are using an OAuth2 library, many of these steps will be handled for you."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request a short-term code, granted when the Kantata OX user agrees to allow your application access."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send your user to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/oauth/authorize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the REQUIRED parameters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"response_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect_uri"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the ID assigned to your application by Kantata OX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"response_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to \"code\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect_uri"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to a URL where your application can accept codes and then exchange them for access tokens. It should match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect_uri"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified when you registered your application."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is an example URL that an application located at \"myapp.com\" might use. (Linebreaks are not included in the URL.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" https://app.mavenlink.com/oauth/authorize?response_type=code&client_id=abc123&redirect_uri=http%3A%2F%2Fmyapp.com%2Foauth%2Fcallback\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" https://app.mavenlink.com/oauth/authorize?response_type=code&client_id=abc123&redirect_uri=http%3A%2F%2Fmyapp.com%2Foauth%2Fcallback\n"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user will be asked by Kantata OX if they want to authorize your application to interact with Kantata OX on their behalf."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If something goes wrong (like the user refused to authorize your application), Kantata OX will redirect to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect_uri"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with query parameters providing information about the error. For example, if authorization is denied, the user will be redirected to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" $REDIRECT_URI?error=access_denied&error_description=The+resource+owner+or+authorization+server+denied+the+request.\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" $REDIRECT_URI?error=access_denied&error_description=The+resource+owner+or+authorization+server+denied+the+request.\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the user allows your application, then Kantata OX will redirect to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect_uri"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with query parameters providing your application with a time-limited code that your application can exchange for an access token within the next 5 minutes. Here is an example redirection with granted access:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" $REDIRECT_URI?code=abc123\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" $REDIRECT_URI?code=abc123\n"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your application exchanges the code for an access token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Now that your application has a code, it should make a POST request directly to Kantata OX at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://app.mavenlink.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to exchange the code for an access token that will allow continued interaction with the Kantata OX API. The request must include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect_uri"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the ID assigned to your application by Kantata OX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the secret token assigned to your application by Kantata OX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to \"authorization_code\" in order to exchange a code for an access token"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the value that was returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter when Kantata OX redirected back to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect_uri"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect_uri"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the exact same value that you used in the original request to /oauth/authorize"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the request is invalid for some reason, an error response like the one described above will be returned. However, the parameters will be returned in the response body, encoded as JSON, instead of in the URL encoded as query parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the request is valid, Kantata OX will provide a response body, encoded in JSON, containing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the token that your application will use to authenticate requests to the Kantata OX API as this user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be \"bearer\""},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your application uses the access token to make authenticated requests to the Kantata OX API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this point, your application can use the access token to authenticate requests made to the Kantata OX API as described above in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}]}]}]}],"sectionId":"/kantata/specification/section/obtaining-tokens-for-users"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/bearer-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security Scheme Type:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API Key"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header parameter name:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Bearer"},"children":[]}]}]}]}],"sectionId":"/kantata/specification/section/bearer-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/oauthsecurity"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OauthSecurity"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security Scheme Type:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth2"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flow type:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizationCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization URL:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://app.mavenlink.com/oauth/authorize"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token URL:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://app.mavenlink.com/oauth/token"},"children":[]}]}]}]}],"sectionId":"/kantata/specification/section/oauthsecurity"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/security"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kantata OX OAuth access tokens do not expire and must be treated with the same security that you would treat client credentials such as passwords. All requests must be made over SSL and all user security credentials must be stored using industry best practices. If a user revokes your application's access, usage of the token will result in an error."},"children":[]}]}]}]}],"sectionId":"/kantata/specification/section/security"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/response-format"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kantata OX API responses come back as JSON. All GET responses will be of a format similar to the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"count\": 2,\n \"results\": [{ key: \"workspaces\", id: \"10\" }, { key: \"workspaces\", id: \"11\" }],\n \"workspaces\": {\n \"10\": {\n id: \"10\",\n title: \"some project\",\n participant_ids: [\"2\", \"6\"],\n primary_counterpart_id: \"6\"\n },\n \"11\": {\n id: \"11\",\n title: \"another project\",\n participant_ids: [\"2\", \"8\"],\n primary_counterpart_id: \"8\"\n }\n },\n \"users\": {\n \"2\": { id: \"2\", full_name: \"bob\" },\n \"6\": { id: \"6\", full_name: \"chaz\" },\n \"8\": { id: \"8\", full_name: \"jane\" }\n }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"count\": 2,\n \"results\": [{ key: \"workspaces\", id: \"10\" }, { key: \"workspaces\", id: \"11\" }],\n \"workspaces\": {\n \"10\": {\n id: \"10\",\n title: \"some project\",\n participant_ids: [\"2\", \"6\"],\n primary_counterpart_id: \"6\"\n },\n \"11\": {\n id: \"11\",\n title: \"another project\",\n participant_ids: [\"2\", \"8\"],\n primary_counterpart_id: \"8\"\n }\n },\n \"users\": {\n \"2\": { id: \"2\", full_name: \"bob\" },\n \"6\": { id: \"6\", full_name: \"chaz\" },\n \"8\": { id: \"8\", full_name: \"jane\" }\n }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As you can see, Kantata OX API responses can return multiple data types simultaneously, transferring objects and their associations in a single response. In this example, the developer has likely requested the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/workspaces.json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint, asking for inclusion of those workspaces' participants and primary counterparts. These associations have come back in the top-level object called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The developer should always use the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array to retrieve the canonical results from an API request. This is because some objects may have associations of the same type and can thus be mixed together with their associations in the JSON. For example, stories (tasks) have sub_stories which are the same type of object, so looking directly at the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key when stories have been requested to include their sub_stories will be confusing and will include both. Instead, iterate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key to determine exactly which top-level objects matched your query and in what order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The follow sections explain how to customize further the Kantata OX API responses to your needs."},"children":[]}]}]}]}],"sectionId":"/kantata/specification/section/response-format"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Large lists of items may be returned in pages. The JSON response will contain a key named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a value of the number of objects returned by the entire query. If that number is greater than the number of objects returned by the request, additional objects may be requested by setting the parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you would like to start at a specific offset you may alternatively use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters. If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are passed then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are ignored, otherwise behavior falls back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type: Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default: 1"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type: Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default: 20"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"maximum: 200"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workspaces.json?page=2&per_page=15"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-or-"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type: Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"minimum: 1"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type: Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"minimum: 0"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workspaces.json?limit=15&offset=10"},"children":[]}]}]}]}]}]}]}],"sectionId":"/kantata/specification/section/pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/request-by-id"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request by ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While each API endpoint returns a paginated listing of the data available, it is sometimes more useful to request only one (or only a few) items. The Kantata OX API provides two ways to do this. The first, via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, allows you to request one or more resources directly by ID. To request the data for a single Workspace with an ID of 5, make an API request to the URL "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/workspaces.json?only=5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple IDs can be supplied in a comma separated list, like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/workspaces.json?only=5,6,7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The returned JSON will contain only the objects with those IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"only"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type: Comma separated Integers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default: not applicable"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usage"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workspaces.json?only=5,6"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, we support traditional RESTful routes, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/workspaces/5.json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". These routes also support our standard filters and includes, both detailed below. Unlike "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requests to our \"index\" routes, these \"show\" routes will generate a 404 response if the requested resource cannot be found. Sometimes this is due to default filters being applied, so be sure to check the filter defaults applied in the specific documentation for the requested resource. More on filters below."},"children":[]}]}]}]}],"sectionId":"/kantata/specification/section/request-by-id"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/filters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Many API endpoints also provide an optional set of filters that can be applied to the data that will be returned. Each filter, and the logic behind it, is documented on the individual endpoint pages, but the general form is a URL query parameter or request parameter like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter1=arg1&filter2=arg2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the names of two different filters, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"arg1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"arg2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the arguments to each filter, respectively. Additionally, some filters have default values, which indicates that they are automatically applied to your request with their default value. Default values are applied both on \"index\" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /workspaces.json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") requests and \"show\" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /workspaces/1.json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") requests."},"children":[]}]}]}]}],"sectionId":"/kantata/specification/section/filters"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/includes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some objects returned by the API may have associations that are not included in the JSON response by default. Those associated objects can be requested by adding an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to the request. For example, to request both a list of posts, and the users that created those posts, you could request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/posts.json?include=user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response will consist of a JSON object with an array of result mappings under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"results\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"posts\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key with a hash of post objects, keyed by id, and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"users\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key with a hash of user objects, again keyed by id. To find the user that created a particular post, just use the post object's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"user_id\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key to find the user object keyed with the same id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple associations may be fetched simultaneously by adding comma-separated values to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. For example, to fetch the user and replies associated with post 6, you might request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/posts.json?only=6&include=user,attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which would supply both the users and the attachments that belong to the posts returned in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -H \"Authorization: Bearer abc123\" \"https://api.mavenlink.com/api/v1/posts.json?include=user,attachments\"\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -H \"Authorization: Bearer abc123\" \"https://api.mavenlink.com/api/v1/posts.json?include=user,attachments\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"count\": 1,\n \"results\": [\n { \"key\": \"posts\", \"id\": \"16270634\" }\n ],\n \"posts\": {\n \"16270634\": {\n \"id\": \"16270634\",\n \"message\": \"Hello World\",\n \"has_attachments\": true,\n \"user_id\": \"2\",\n \"workspace_id\": \"2249167\",\n \"attachment_ids\": [\"6700107\"]\n }\n },\n \"users\": {\n \"2\": {\n \"id\": \"2\",\n \"full_name\": \"John Doe\",\n \"email_address\": \"johnny_doe@example.com\"\n }\n },\n \"attachments\": {\n \"6700107\": {\n \"id\": \"6700107\",\n \"created_at\": \"2013-04-15T16:48:48-07:00\",\n \"filename\": \"turtle.jpg\",\n \"filesize\": 16225\n }\n }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"count\": 1,\n \"results\": [\n { \"key\": \"posts\", \"id\": \"16270634\" }\n ],\n \"posts\": {\n \"16270634\": {\n \"id\": \"16270634\",\n \"message\": \"Hello World\",\n \"has_attachments\": true,\n \"user_id\": \"2\",\n \"workspace_id\": \"2249167\",\n \"attachment_ids\": [\"6700107\"]\n }\n },\n \"users\": {\n \"2\": {\n \"id\": \"2\",\n \"full_name\": \"John Doe\",\n \"email_address\": \"johnny_doe@example.com\"\n }\n },\n \"attachments\": {\n \"6700107\": {\n \"id\": \"6700107\",\n \"created_at\": \"2013-04-15T16:48:48-07:00\",\n \"filename\": \"turtle.jpg\",\n \"filesize\": 16225\n }\n }\n}\n"},"children":[]}]}]}],"sectionId":"/kantata/specification/section/includes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/optional-fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional Fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some objects returned by the API may have fields that are not included in the JSON response by default. Those optional fields can be requested by adding an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to the request. For example, to request a list of stories and include the optional field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"can_edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you could request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/stories.json?optional_fields=can_edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each story in the response will include the requested optional field in their JSON."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple optional fields may be requested simultaneously by adding comma-separated values to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. For example, to fetch stories and include both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"can_edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"can_post"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields in the response, you can request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/stories.json?optional_fields=can_edit,can_post"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -H \"Authorization: Bearer abc123\" \"https://api.mavenlink.com/api/v1/stories.json?optional_fields=can_edit,can_post\"\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -H \"Authorization: Bearer abc123\" \"https://api.mavenlink.com/api/v1/stories.json?optional_fields=can_edit,can_post\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"count\": 1,\n \"results\": [\n {\n \"key\": \"stories\",\n \"id\": \"1941361\"\n }\n ],\n \"stories\": {\n \"1937928\": {\n \"title\": \"Example Story\",\n \"description\": \"example description\",\n ...\n \"subtree_depth\": 0,\n \"ancestry_depth\": 0,\n \"can_edit\": true,\n \"can_post\": true,\n \"time_trackable\": true,\n \"time_estimate_in_minutes\": null,\n ...\n \"parent_id\": null,\n \"root_id\": null,\n \"id\": \"1937928\"\n }\n },\n \"meta\": {\n \"count\": 1,\n \"page_count\": 1,\n \"page_number\": 1,\n \"page_size\": 20\n }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"count\": 1,\n \"results\": [\n {\n \"key\": \"stories\",\n \"id\": \"1941361\"\n }\n ],\n \"stories\": {\n \"1937928\": {\n \"title\": \"Example Story\",\n \"description\": \"example description\",\n ...\n \"subtree_depth\": 0,\n \"ancestry_depth\": 0,\n \"can_edit\": true,\n \"can_post\": true,\n \"time_trackable\": true,\n \"time_estimate_in_minutes\": null,\n ...\n \"parent_id\": null,\n \"root_id\": null,\n \"id\": \"1937928\"\n }\n },\n \"meta\": {\n \"count\": 1,\n \"page_count\": 1,\n \"page_number\": 1,\n \"page_size\": 20\n }\n}\n"},"children":[]}]}]}],"sectionId":"/kantata/specification/section/optional-fields"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/ordering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ordering"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each endpoint in the Kantata OX API allows ordering by various fields. If we're missing a sort field that you need, please ask! See the specific endpoint documentation for endpoint-specific details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When ordering, supply "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the name of a valid sort field for the endpoint and a direction. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order=created_at:desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/kantata/specification/section/ordering"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/searching"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some API endpoints support text search, however only some filters can be combined with search, and results will be returned ordered by relevancy to the search query. Search does not apply to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requests. If search is unavailable the response will contain a system error describing the problem."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To make a search request, simply add a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to the request. For example, to search for stories with \"estimates\" in the title, assignee names, or other fields, request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/stories.json?search=estimates"},"children":[]}]}]}]}],"sectionId":"/kantata/specification/section/searching"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there is an error while processing your request, the response will include an HTTP status code indicating the error. Errors are currently returned as a top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key with an array of error objects. For example, on OAuth failure you will receive a HTTP 401 with the following JSON body:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n errors: [\n {\n type: \"oauth\"\n message: \"Invalid OAuth 2 Request\"\n }\n ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n errors: [\n {\n type: \"oauth\"\n message: \"Invalid OAuth 2 Request\"\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System errors will look like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n errors: [\n {\n type: \"system\"\n message: \"Your account has been canceled\"\n }\n ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n errors: [\n {\n type: \"system\"\n message: \"Your account has been canceled\"\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"And model validation errors look like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n errors: [\n {\n type: \"validation\",\n message: \"Please give your project a title\",\n field: \"title\"\n },\n {\n type: \"validation\",\n message: \"Please select a role for this project\",\n field: \"creator_role\"\n }\n ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n errors: [\n {\n type: \"validation\",\n message: \"Please give your project a title\",\n field: \"title\"\n },\n {\n type: \"validation\",\n message: \"Please select a role for this project\",\n field: \"creator_role\"\n }\n ]\n}\n"},"children":[]}]}]}],"sectionId":"/kantata/specification/section/errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/rate-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When too many requests are made in a short amount of time, the API may reply with the HTTP code 429 Too Many Requests. In that case, simply retry your request after a small delay."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are general rate limits applied to all requests. The following endpoints also have their own rate limits:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Workspaces#operation/create-workspace"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a workspace"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/v1/workspaces"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Workspaces#operation/get-workspaces"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get workspaces"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/workspaces"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Workspaces#operation/create-workspace-invitation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a workspace invitation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/v1/workspaces/{id}/invite"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Account-Invitations#operation/create-account-invitation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an account invitation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e. Create a new user) - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/v1/account_invitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Account-Invitations#operation/resend-account-invitation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resend an account invitation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /api/v1/account_invitations/{id}/resend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Custom-Field-Values#operation/create-custom-field-value"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create custom field value"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/v1/custom_field_values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Custom-Field-Values#operation/get-custom-field-values"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get custom field values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/custom_field_values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Project-Snapshots#operation/create-project-snapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a project snapshot"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/v1/project_snapshots"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/9698066628123"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the exact rate limits."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that we reserve the right to change the limits at any time. In addition, if we determine that someone is using the API improperly, we may adjust the limits further."},"children":[]}]}]}]}],"sectionId":"/kantata/specification/section/rate-limits"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/timeouts"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeouts"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests will timeout after 3 minutes. Timeouts typically occur when there is a lot of data to return. You can use the following strategies to avoid your requests timing out:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Break up your request into smaller requests"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply a date filter to your request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are polling multiple endpoints in order to export data or sync Kantata data to a third-party system, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Events"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribed Events API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. You can get recently updated objects in one request."},"children":[]}]}]}]}]}],"sectionId":"/kantata/specification/section/timeouts"}]}]}},{"type":"link","label":"Schema","link":"/kantata/specification/section/schema","routeSlug":"/kantata/specification/section/schema","content":null},{"type":"link","label":"Authentication","link":"/kantata/specification/section/authentication","routeSlug":"/kantata/specification/section/authentication","content":null},{"type":"link","label":"OAuth 2.0","link":"/kantata/specification/section/oauth-2.0","routeSlug":"/kantata/specification/section/oauth-2.0","content":null},{"type":"link","label":"Registering your application","link":"/kantata/specification/section/registering-your-application","routeSlug":"/kantata/specification/section/registering-your-application","content":null},{"type":"link","label":"Obtaining tokens for users","link":"/kantata/specification/section/obtaining-tokens-for-users","routeSlug":"/kantata/specification/section/obtaining-tokens-for-users","content":null},{"type":"link","label":"Bearer Token","link":"/kantata/specification/section/bearer-token","routeSlug":"/kantata/specification/section/bearer-token","content":null},{"type":"link","label":"OauthSecurity","link":"/kantata/specification/section/oauthsecurity","routeSlug":"/kantata/specification/section/oauthsecurity","content":null},{"type":"link","label":"Security","link":"/kantata/specification/section/security","routeSlug":"/kantata/specification/section/security","content":null},{"type":"link","label":"Response Format","link":"/kantata/specification/section/response-format","routeSlug":"/kantata/specification/section/response-format","content":null},{"type":"link","label":"Pagination","link":"/kantata/specification/section/pagination","routeSlug":"/kantata/specification/section/pagination","content":null},{"type":"link","label":"Request by ID","link":"/kantata/specification/section/request-by-id","routeSlug":"/kantata/specification/section/request-by-id","content":null},{"type":"link","label":"Filters","link":"/kantata/specification/section/filters","routeSlug":"/kantata/specification/section/filters","content":null},{"type":"link","label":"Includes","link":"/kantata/specification/section/includes","routeSlug":"/kantata/specification/section/includes","content":null},{"type":"link","label":"Optional Fields","link":"/kantata/specification/section/optional-fields","routeSlug":"/kantata/specification/section/optional-fields","content":null},{"type":"link","label":"Ordering","link":"/kantata/specification/section/ordering","routeSlug":"/kantata/specification/section/ordering","content":null},{"type":"link","label":"Searching","link":"/kantata/specification/section/searching","routeSlug":"/kantata/specification/section/searching","content":null},{"type":"link","label":"Errors","link":"/kantata/specification/section/errors","routeSlug":"/kantata/specification/section/errors","content":null},{"type":"link","label":"Rate Limits","link":"/kantata/specification/section/rate-limits","routeSlug":"/kantata/specification/section/rate-limits","content":null},{"type":"link","label":"Timeouts","link":"/kantata/specification/section/timeouts","routeSlug":"/kantata/specification/section/timeouts","content":null},{"type":"separator","label":"# Subscribed Events","content":null},{"type":"group","label":"Event Types","link":"/kantata/specification/event-types","routeSlug":"/kantata/specification/event-types","items":[{"label":"Fetching a list of Subscribed Event Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/event-types/get subscribed event types","routeSlug":"/kantata/specification/event-types/get subscribed event types","metadata":{"seo":{"title":"Fetching a list of Subscribed Event Types","description":"Returns a list of all Event Typestracked by Subscribed Events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Subscribed Event Types","name":"Fetching a list of Subscribed Event Types","isWebhook":false,"pointer":"/paths/~1subscribed_events~1event_types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Subscribed Event Types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/4407962435227"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event Types"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tracked by Subscribed Events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event type schema, accessible using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscribed_event_type_schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key, is metadata that shows"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the structure of all events. The event types schema includes documentation for the events and fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can reference the event types schema as you build your application that processes subscribed events."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscribed_events/event_types","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/subscribed_events/event_types","href":"event-types/get subscribed event types","openApiOperationId":"Get Subscribed Event Types","summary":"Fetching a list of Subscribed Event Types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Event Types have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_302"}},"schemaId":"schema_302"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1subscribed_events~1event_types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_302","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_302"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/subscribed_events/event_types"}],"content":{"contentType":"group","meta":{"name":"Event Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Event Types","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A change is called a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/4407962435227"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribed Event"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the type of change is called a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribed Event Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only Account Administrators can access Subscribed Events."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscribed_events/event_types","summary":"Fetching a list of Subscribed Event Types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-types/get subscribed event types","deprecated":false}]}]}]}]}},{"type":"group","label":"Events","link":"/kantata/specification/events","routeSlug":"/kantata/specification/events","items":[{"label":"Fetching a list of Subscribed Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/events/get subscribed events","routeSlug":"/kantata/specification/events/get subscribed events","metadata":{"seo":{"title":"Fetching a list of Subscribed Events","description":"Returns up to 9 days of records for all event types,unless filter parameters have been applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Subscribed Events","name":"Fetching a list of Subscribed Events","isWebhook":false,"pointer":"/paths/~1subscribed_events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Subscribed Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns up to 9 days of records for all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/4407962435227"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unless filter parameters have been applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only records associated with the requester's Kantata OX account are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Subscribed Event objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscribed_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for events created after a specified datetime. Events may be generated out of order or the\n`subject_changed_at` and `created_at` times of an event can differ due to the lag between event\noccurrence and generation. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for events created before a specified datetime. Events may be generated out of order or the\n`subject_changed_at` and `created_at` times of an event can differ due to the lag between event\noccurrence and generation. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"event_types","in":"query","schemaId":"schema_304","description":"Filter for records of specified [event types](https://mavenlink.zendesk.com/hc/en-us/articles/4407962435227).\nSpecify multiple event types in a comma-separated list, like\n`GET /api/v1/subscribed_events?event_types=time_entry:created,time_entry:updated,time_entry:deleted`."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `subject` (polymorphic) - When included, each event object will include a `subject_ref` that references the subject the event belongs to. The `subject_ref` is a JSON object with an `id` and `key`, where the `key` is the subject type.\n\nFor example, a `workspace:updated` event will have a `subject_ref` referencing the workspace, and the `key` will be `workspaces`.\n\nIf the subject is not available, `subject_ref` will be null. A subject may be unavailable if it was deleted or was transferred to another account."},{"name":"most_recent","in":"query","schemaId":"schema_305","description":"If true, only the most recent event will be returned for each subject\n(i.e. the most recent change that occurred for each subject). This filter cannot be used\nin combination with `most_recent_by_event_type`."},{"name":"most_recent_by_event_type","in":"query","schemaId":"schema_305","description":"If true, only the most recent event of each event type will be returned for each subject.\n\nFor example, if a workspace was created, updated 3 times, and deleted, the following events will be\ngenerated: 1 `workspace:created` event, 3 `workspace:updated` events, and 1 `workspace:deleted` event.\nIf `most_recent_by_event_type` is true, the `workspace:created` event, the most recent `workspace:updated`\nevent, and the `workspace:deleted` event will be returned. This filter cannot be used in combination with\n`most_recent`."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"optional_fields","in":"query","schemaId":"schema_306","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"subject_id","in":"query","schemaId":"schema_304","description":"Filter for events belonging to a specific subject (e.g. a user, a project, etc). When using this filter,\nyou must also provide a `subject_type`. Multiple IDs can be provided in a comma-separated list\n(e.g. `GET /api/v1/subscribed_events?subject_type=TimeEntry&subject_id=27,28,29`)."},{"name":"subject_type","in":"query","schemaId":"schema_304","description":"Filter for events by a specific subject type. You can pass in only one subject type for this parameter.\n Supported subject types: \"AccountColor\", \"AccountLocation\", \"AccountMembership\", \"Assignment\", \"BudgetChangeOrder\",\n \"CostRate\", \"CustomField\", \"CustomFieldSet\", \"DefaultStatusSet\", \"EmailAddress\", \"Estimate\", \"EstimateScenario\",\n \"EstimateScenarioResource\", \"Expense\", \"ExpenseReportSubmission\", \"Invoice\", \"LineItemLock\", \"Organization\",\n \"OrganizationMembership\", \"Participation\", \"ProjectAccessControl\", \"Role\", \"ScheduleChangeOrder\", \"Skill\",\n \"SkillMembership\", \"StatusSet\", \"StatusSetOption\", \"Story\", \"StoryAllocationDay\", \"TimeEntry\",\n \"TimeOffEntry\", \"TimesheetSubmission\", \"User\", \"Vendor\", \"Workspace\", \"WorkspaceAllocation\", \"WorkspaceApprover\",\n \"WorkspaceGroup\", \"WorkspaceInvitation\", \"WorkspaceResource\", \"WorkspaceStatusSet\", \"Workweek\", \"WorkweekMembership\"."},{"name":"user_ids","in":"query","schemaId":"schema_304","description":"Filter for events triggered by specific users. Multiple IDs can be provided in a comma-separated list\n(e.g. `GET /api/v1/subscribed_events?user_ids=5,25,45`)."}],"pointer":"/paths/~1subscribed_events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscribed_events","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","required":false,"schemaId":"schema_303"},{"name":"created_before","in":"query","required":false,"schemaId":"schema_303"},{"name":"event_types","in":"query","required":false,"schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"most_recent","in":"query","required":false,"schemaId":"schema_305"},{"name":"most_recent_by_event_type","in":"query","required":false,"schemaId":"schema_305"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_306","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"subject_id","in":"query","required":false,"schemaId":"schema_304"},{"name":"subject_type","in":"query","required":false,"schemaId":"schema_304"},{"name":"user_ids","in":"query","required":false,"schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/subscribed_events","href":"events/get subscribed events","openApiOperationId":"Get Subscribed Events","summary":"Fetching a list of Subscribed Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Subscribed Events have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_310"}},"schemaId":"schema_310"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1subscribed_events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_310","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_310"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/subscribed_events"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 9 days of trackable changes (\"events\") for an account can be accessed via the Subscribed Events API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of all the event types tracked by Subscribed Events, please see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/4407962435227"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only Account Administrators can access Subscribed Events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some actions performed in Kantata OX can generate multiple events. For instance, approving an Expense Report will generate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_report:updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense:updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events. Note that events for the same action are not guaranteed to appear in the exact order the changes were completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also note that although we try to create events within a few minutes of an action being performed, events may take some time to appear."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, events may sometimes be duplicated. Your application should handle duplicate events appropriately."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscribed_events","summary":"Fetching a list of Subscribed Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/get subscribed events","deprecated":false}]}]}]}]}},{"type":"separator","label":"Account Locations","content":null},{"type":"group","label":"Account Locations","link":"/kantata/specification/account-locations","routeSlug":"/kantata/specification/account-locations","items":[{"label":"Fetching a list of Account Locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-locations/get account locations","routeSlug":"/kantata/specification/account-locations/get account locations","metadata":{"seo":{"title":"Fetching a list of Account Locations","description":"This endpoint returns structured Account Location objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the account_locations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Account Locations","name":"Fetching a list of Account Locations","isWebhook":false,"pointer":"/paths/~1account_locations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Account Locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Location objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"archived","in":"query","schemaId":"schema_311","description":"Only includes archived account locations, based on the specified option. Options are 'only', 'exclude', or 'include'."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_312","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `name:asc` and `name:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Returns account locations for the account on the specified workspace."}],"pointer":"/paths/~1account_locations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_locations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"archived","in":"query","schemaId":"schema_311"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_312"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_locations","href":"account-locations/get account locations","openApiOperationId":"Get Account Locations","summary":"Fetching a list of Account Locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Account Locations have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314"}},"schemaId":"schema_314"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_locations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_314","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_locations"},{"label":"Creating a new Account Location","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-locations/create account location","routeSlug":"/kantata/specification/account-locations/create account location","metadata":{"seo":{"title":"Creating a new Account Location","description":"This endpoint returns structured Account Location objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the account_locations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Account Location","name":"Creating a new Account Location","isWebhook":false,"pointer":"/paths/~1account_locations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Account Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Location objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_315"}},"schemaId":"schema_315","pointer":"/paths/~1account_locations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/account_locations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_315"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_locations","href":"account-locations/create account location","openApiOperationId":"Create Account Location","summary":"Creating a new Account Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_315","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_315"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Location has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314"}},"schemaId":"schema_314"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_locations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_314","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_locations"},{"label":"Updating an existing Account Location","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-locations/update account location","routeSlug":"/kantata/specification/account-locations/update account location","metadata":{"seo":{"title":"Updating an existing Account Location","description":"This endpoint returns structured Account Location objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the account_locations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Account Location","name":"Updating an existing Account Location","isWebhook":false,"pointer":"/paths/~1account_locations~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Account Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Location objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1account_locations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_317"}},"schemaId":"schema_317","pointer":"/paths/~1account_locations~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/account_locations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_317"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_locations/{id}","href":"account-locations/update account location","openApiOperationId":"Update Account Location","summary":"Updating an existing Account Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_317","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_317"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Location has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314"}},"schemaId":"schema_314"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_locations~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_314","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_locations/{id}"},{"label":"Deleting an existing Account Location","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-locations/delete account location","routeSlug":"/kantata/specification/account-locations/delete account location","metadata":{"seo":{"title":"Deleting an existing Account Location","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Account Location","name":"Deleting an existing Account Location","isWebhook":false,"pointer":"/paths/~1account_locations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Account Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1account_locations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/account_locations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/account_locations/{id}","href":"account-locations/delete account location","openApiOperationId":"Delete Account Location","summary":"Deleting an existing Account Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Account Location has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_locations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_locations/{id}"}],"content":{"contentType":"group","meta":{"name":"Account Locations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Locations","showPageActions":true},{"nodeType":"markdoc","content":"Represents a location associated with an account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_locations","summary":"Fetching a list of Account Locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-locations/get account locations","deprecated":false},{"title":"/account_locations","summary":"Creating a new Account Location","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-locations/create account location","deprecated":false},{"title":"/account_locations/{id}","summary":"Updating an existing Account Location","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-locations/update account location","deprecated":false},{"title":"/account_locations/{id}","summary":"Deleting an existing Account Location","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-locations/delete account location","deprecated":false}]}]}]}]}},{"type":"separator","label":"Account Settings & Members","content":null},{"type":"group","label":"Access Group Memberships","link":"/kantata/specification/access-group-memberships","routeSlug":"/kantata/specification/access-group-memberships","items":[{"label":"Fetching a list of Access Group Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/access-group-memberships/get access group memberships","routeSlug":"/kantata/specification/access-group-memberships/get access group memberships","metadata":{"seo":{"title":"Fetching a list of Access Group Memberships","description":"Returns all access group memberships. The non-editable \"Account Administrators\" group is excluded from the response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Access Group Memberships","name":"Fetching a list of Access Group Memberships","isWebhook":false,"pointer":"/paths/~1access_group_memberships/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Access Group Memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all access group memberships. The non-editable \"Account Administrators\" group is excluded from the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Access Group Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_group_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"access_group_id","in":"query","schemaId":"schema_313","description":"Returns only access group memberships for a specified access group."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `access_group` (AccessGroup) - References the associated access group.\n- `user` (User) - References the associated user."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"user_id","in":"query","schemaId":"schema_313","description":"Returns only access group memberships for a specified user."}],"pointer":"/paths/~1access_group_memberships/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/access_group_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"access_group_id","in":"query","schemaId":"schema_313"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"user_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/access_group_memberships","href":"access-group-memberships/get access group memberships","openApiOperationId":"Get Access Group Memberships","summary":"Fetching a list of Access Group Memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Access Group Memberships have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_318"}},"schemaId":"schema_318"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1access_group_memberships/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_318","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_318"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/access_group_memberships"},{"label":"Creating a new Access Group Membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/access-group-memberships/create access group membership","routeSlug":"/kantata/specification/access-group-memberships/create access group membership","metadata":{"seo":{"title":"Creating a new Access Group Membership","description":"Adds a user to an access group. Note: To add a user to the Account Administrators access group, you must updatethe user's account membership permission instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Access Group Membership","name":"Creating a new Access Group Membership","isWebhook":false,"pointer":"/paths/~1access_group_memberships/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Access Group Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a user to an access group. Note: To add a user to the Account Administrators access group, you must update"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the user's account membership permission instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Access Group Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_group_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `access_group` (AccessGroup) - References the associated access group.\n- `user` (User) - References the associated user."}],"pointer":"/paths/~1access_group_memberships/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_319"}},"schemaId":"schema_319","pointer":"/paths/~1access_group_memberships/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/access_group_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_319"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/access_group_memberships","href":"access-group-memberships/create access group membership","openApiOperationId":"Create Access Group Membership","summary":"Creating a new Access Group Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_319","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_319"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Access Group Membership has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_318"}},"schemaId":"schema_318"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1access_group_memberships/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_318","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_318"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/access_group_memberships"},{"label":"Fetching a single Access Group Membership","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/access-group-memberships/get access group membership","routeSlug":"/kantata/specification/access-group-memberships/get access group membership","metadata":{"seo":{"title":"Fetching a single Access Group Membership","description":"This endpoint returns structured Access Group Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the access_group_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Access Group Membership","name":"Fetching a single Access Group Membership","isWebhook":false,"pointer":"/paths/~1access_group_memberships~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Access Group Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Access Group Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_group_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1access_group_memberships~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `access_group` (AccessGroup) - References the associated access group.\n- `user` (User) - References the associated user."}],"pointer":"/paths/~1access_group_memberships~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/access_group_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/access_group_memberships/{id}","href":"access-group-memberships/get access group membership","openApiOperationId":"Get Access Group Membership","summary":"Fetching a single Access Group Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Access Group Membership has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_318"}},"schemaId":"schema_318"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1access_group_memberships~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_318","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_318"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/access_group_memberships/{id}"},{"label":"Deleting an existing Access Group Membership","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/access-group-memberships/delete access group membership","routeSlug":"/kantata/specification/access-group-memberships/delete access group membership","metadata":{"seo":{"title":"Deleting an existing Access Group Membership","description":"Deletes the specified access group membership (i.e. removes the user from the access group). Note: To remove a userfrom the Account Administrators access group, you must update the user's account membership permission instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Access Group Membership","name":"Deleting an existing Access Group Membership","isWebhook":false,"pointer":"/paths/~1access_group_memberships~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Access Group Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the specified access group membership (i.e. removes the user from the access group). Note: To remove a user"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the Account Administrators access group, you must update the user's account membership permission instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1access_group_memberships~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/access_group_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/access_group_memberships/{id}","href":"access-group-memberships/delete access group membership","openApiOperationId":"Delete Access Group Membership","summary":"Deleting an existing Access Group Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Access Group Membership has been deleted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_320"}},"schemaId":"schema_320"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1access_group_memberships~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_320","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_320"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/access_group_memberships/{id}"}],"content":{"contentType":"group","meta":{"name":"Access Group Memberships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Access Group Memberships","showPageActions":true},{"nodeType":"markdoc","content":"Access Groups allow you to manage product access for users. An Access Group Membership represents the connection of a user to an Access Group."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/access_group_memberships","summary":"Fetching a list of Access Group Memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/access-group-memberships/get access group memberships","deprecated":false},{"title":"/access_group_memberships","summary":"Creating a new Access Group Membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/access-group-memberships/create access group membership","deprecated":false},{"title":"/access_group_memberships/{id}","summary":"Fetching a single Access Group Membership","prefix":{"name":"get","color":"get"},"badges":[],"link":"/access-group-memberships/get access group membership","deprecated":false},{"title":"/access_group_memberships/{id}","summary":"Deleting an existing Access Group Membership","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/access-group-memberships/delete access group membership","deprecated":false}]}]}]}]}},{"type":"group","label":"Account Colors","link":"/kantata/specification/account-colors","routeSlug":"/kantata/specification/account-colors","items":[{"label":"Fetching a list of Account Colors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-colors/get account colors","routeSlug":"/kantata/specification/account-colors/get account colors","metadata":{"seo":{"title":"Fetching a list of Account Colors","description":"Each project in Kantata OX can be tagged with a Project Color for categorization purposes. The colors thatare available for projects are defined at the account level. Use the id of Account Color to read and updateProject Colors using the workspaces endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Account Colors","name":"Fetching a list of Account Colors","isWebhook":false,"pointer":"/paths/~1account_colors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Account Colors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each project in Kantata OX can be tagged with a Project Color for categorization purposes. The colors that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are available for projects are defined at the account level. Use the id of Account Color to read and update"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project Colors using the workspaces endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Color objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_colors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"enabled_only","in":"query","schemaId":"schema_321","description":"Include only the colors that are enabled on the account."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Limits account colors to names matching the specified query."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1account_colors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_colors","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"enabled_only","in":"query","schemaId":"schema_321"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_colors","href":"account-colors/get account colors","openApiOperationId":"Get Account Colors","summary":"Fetching a list of Account Colors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Account Colors have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_322"}},"schemaId":"schema_322"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_colors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_322","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_322"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_colors"}],"content":{"contentType":"group","meta":{"name":"Account Colors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Colors","showPageActions":true},{"nodeType":"markdoc","content":"Account Colors are the colors available on a user's account that can be used to style workspaces."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_colors","summary":"Fetching a list of Account Colors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-colors/get account colors","deprecated":false}]}]}]}]}},{"type":"group","label":"Account Invitations","link":"/kantata/specification/account-invitations","routeSlug":"/kantata/specification/account-invitations","items":[{"label":"Fetching a list of Account Invitations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-invitations/get account invitations","routeSlug":"/kantata/specification/account-invitations/get account invitations","metadata":{"seo":{"title":"Fetching a list of Account Invitations","description":"This endpoint returns structured Account Invitation objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the account_invitations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Account Invitations","name":"Fetching a list of Account Invitations","isWebhook":false,"pointer":"/paths/~1account_invitations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Account Invitations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Invitation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_invitations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"by_full_name","in":"query","schemaId":"schema_304","description":"Show entries where the full name is like the specified parameter."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `default_role` (Role) - The default role of the account.\n- `invitee` (User) - The new user who will receive the invitation.\n- `inviter` (User) - The user who has sent the invitation."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"only_pending","in":"query","schemaId":"schema_321","description":"Show only pending invitations."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `bill_rate:asc`, `bill_rate:desc`, `cost_rate:asc`, `cost_rate:desc`, `created_at:asc`, `created_at:desc`, `expiration_date:asc`, `expiration_date:desc`, `full_name:asc`, `full_name:desc`, `permission:asc`, and `permission:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"search","in":"query","schemaId":"schema_304"}],"pointer":"/paths/~1account_invitations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_invitations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"by_full_name","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"only_pending","in":"query","schemaId":"schema_321"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"search","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_invitations","href":"account-invitations/get account invitations","openApiOperationId":"Get Account Invitations","summary":"Fetching a list of Account Invitations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Account Invitations have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_invitations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_invitations"},{"label":"Creating a new Account Invitation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-invitations/create account invitation","routeSlug":"/kantata/specification/account-invitations/create account invitation","metadata":{"seo":{"title":"Creating a new Account Invitation","description":"Adds a user to your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Account Invitation","name":"Creating a new Account Invitation","isWebhook":false,"pointer":"/paths/~1account_invitations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Account Invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a user to your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any members added in excess of your contracted license count are billed at a prorated subscription fee for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the remainder of the billing term. To review your contracted license count,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in Kantata OX, hover over Settings in the left navigation and select Plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has its own rate limit. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/9698066628123"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 50 objects. In the request body, set the top-level key to its plural"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"account_invitations\": [\n {\n \"email_address\": \"email@email.com\",\n \"full_name\": \"Full Name\"\n },\n {\n \"email_address\": \"email@email.com\",\n \"full_name\": \"Full Name\"\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"account_invitations\": [\n {\n \"email_address\": \"email@email.com\",\n \"full_name\": \"Full Name\"\n },\n {\n \"email_address\": \"email@email.com\",\n \"full_name\": \"Full Name\"\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Invitation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_invitations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `default_role` (Role) - The default role of the account.\n- `invitee` (User) - The new user who will receive the invitation.\n- `inviter` (User) - The user who has sent the invitation."}],"pointer":"/paths/~1account_invitations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_324"}},"schemaId":"schema_324","pointer":"/paths/~1account_invitations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/account_invitations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_324"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_invitations","href":"account-invitations/create account invitation","openApiOperationId":"Create Account Invitation","summary":"Creating a new Account Invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_324","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_324"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Invitation has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_invitations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_invitations"},{"label":"Fetching a single Account Invitation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-invitations/get account invitation","routeSlug":"/kantata/specification/account-invitations/get account invitation","metadata":{"seo":{"title":"Fetching a single Account Invitation","description":"This endpoint returns structured Account Invitation objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the account_invitations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Account Invitation","name":"Fetching a single Account Invitation","isWebhook":false,"pointer":"/paths/~1account_invitations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Account Invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Invitation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_invitations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1account_invitations~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `default_role` (Role) - The default role of the account.\n- `invitee` (User) - The new user who will receive the invitation.\n- `inviter` (User) - The user who has sent the invitation."}],"pointer":"/paths/~1account_invitations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_invitations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_invitations/{id}","href":"account-invitations/get account invitation","openApiOperationId":"Get Account Invitation","summary":"Fetching a single Account Invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Account Invitation has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_invitations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_invitations/{id}"},{"label":"Updating an existing Account Invitation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-invitations/update account invitation","routeSlug":"/kantata/specification/account-invitations/update account invitation","metadata":{"seo":{"title":"Updating an existing Account Invitation","description":"This endpoint returns structured Account Invitation objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the account_invitations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Account Invitation","name":"Updating an existing Account Invitation","isWebhook":false,"pointer":"/paths/~1account_invitations~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Account Invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Invitation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_invitations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1account_invitations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `default_role` (Role) - The default role of the account.\n- `invitee` (User) - The new user who will receive the invitation.\n- `inviter` (User) - The user who has sent the invitation."}],"pointer":"/paths/~1account_invitations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_325"}},"schemaId":"schema_325","pointer":"/paths/~1account_invitations~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/account_invitations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_325"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_invitations/{id}","href":"account-invitations/update account invitation","openApiOperationId":"Update Account Invitation","summary":"Updating an existing Account Invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_325","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_325"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Invitation has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_invitations~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_invitations/{id}"},{"label":"Deleting an existing Account Invitation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-invitations/delete account invitation","routeSlug":"/kantata/specification/account-invitations/delete account invitation","metadata":{"seo":{"title":"Deleting an existing Account Invitation","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Account Invitation","name":"Deleting an existing Account Invitation","isWebhook":false,"pointer":"/paths/~1account_invitations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Account Invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1account_invitations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/account_invitations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/account_invitations/{id}","href":"account-invitations/delete account invitation","openApiOperationId":"Delete Account Invitation","summary":"Deleting an existing Account Invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Account Invitation has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_invitations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_invitations/{id}"},{"label":"Resend an account invitation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-invitations/resend account invitation","routeSlug":"/kantata/specification/account-invitations/resend account invitation","metadata":{"seo":{"title":"Resend an account invitation","description":"Resends an account invitation email to an invited user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Resend Account Invitation","name":"Resend an account invitation","isWebhook":false,"pointer":"/paths/~1account_invitations~1{id}~1resend/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend an account invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resends an account invitation email to an invited user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has its own rate limit. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/9698066628123"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Invitation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_invitations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1account_invitations~1{id}~1resend/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `default_role` (Role) - The default role of the account.\n- `invitee` (User) - The new user who will receive the invitation.\n- `inviter` (User) - The user who has sent the invitation."}],"pointer":"/paths/~1account_invitations~1{id}~1resend/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/account_invitations/{id}/resend","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_invitations/{id}/resend","href":"account-invitations/resend account invitation","openApiOperationId":"Resend Account Invitation","summary":"Resend an account invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Invitation has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_invitations~1{id}~1resend/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_invitations/{id}/resend"}],"content":{"contentType":"group","meta":{"name":"Account Invitations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Invitations","showPageActions":true},{"nodeType":"markdoc","content":"Account Invitations represent invitations for non-users to join a Kantata OX account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_invitations","summary":"Fetching a list of Account Invitations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-invitations/get account invitations","deprecated":false},{"title":"/account_invitations","summary":"Creating a new Account Invitation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-invitations/create account invitation","deprecated":false},{"title":"/account_invitations/{id}","summary":"Fetching a single Account Invitation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-invitations/get account invitation","deprecated":false},{"title":"/account_invitations/{id}","summary":"Updating an existing Account Invitation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-invitations/update account invitation","deprecated":false},{"title":"/account_invitations/{id}","summary":"Deleting an existing Account Invitation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-invitations/delete account invitation","deprecated":false},{"title":"/account_invitations/{id}/resend","summary":"Resend an account invitation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-invitations/resend account invitation","deprecated":false}]}]}]}]}},{"type":"group","label":"Account Memberships","link":"/kantata/specification/account-memberships","routeSlug":"/kantata/specification/account-memberships","items":[{"label":"Fetching a list of Account Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-memberships/get account memberships","routeSlug":"/kantata/specification/account-memberships/get account memberships","metadata":{"seo":{"title":"Fetching a list of Account Memberships","description":"You can request either GET /api/v1/account_memberships.json?only=5 orGET /api/v1/account_memberships/5.json. In both cases, default filters will be applied.Unless you provide the is_active:false filter, you won't receive account membership for inactive users, and will get a 404 statuson the \"show\" route."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Account Memberships","name":"Fetching a list of Account Memberships","isWebhook":false,"pointer":"/paths/~1account_memberships/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Account Memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request either GET /api/v1/account_memberships.json?only=5 or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /api/v1/account_memberships/5.json. In both cases, default filters will be applied."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unless you provide the is_active:false filter, you won't receive account membership for inactive users, and will get a 404 status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the \"show\" route."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"by_full_name","in":"query","schemaId":"schema_304","description":"Search account memberships by full name of the user."},{"name":"by_user_id","in":"query","schemaId":"schema_313","description":"Only includes account membership for the specified user ID."},{"name":"can_log_in","in":"query","schemaId":"schema_305","description":"Return account memberships based on whether or not the member is allowed to login."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `backup_approver_associations` (BackupApproverAssociation) - Retrieves the [backup approver associations](/tag/Backup-Approver-Associations) for the user this account membership is for, which represent a backup time approver for a specific date range. The response will include `backup_approver_association_ids`, which references the data in the `backup_approver_associations` top-level key.\n- `cost_rates` (CostRate) - Retrieves all the cost rates in different currencies for the user this account membership is for. The response will include `cost_rate_ids`, which references the data in the `cost_rates` top-level key.\n- `default_role` (Role) - Retrieves the default role, if any, for this account membership. The response will include `default_role_id`, which references the data in the `roles` top-level key.\n- `effective_workweek` (Workweek) - Retrieves the workweek that is in effect today for the user this account membership is for. The response will include `effective_workweek_id`, which references the data in the `workweeks` top-level key.\n- `future_billable_utilizations` (BillableUtilization) - Retrieves the future billable utilizations for the user this account membership is for. The response will include `future_billable_utilization_ids`, which references the data in the `billable_utilizations` top-level key.\n- `managees` (User) - Retrieves the direct reports of the user this account membership is for. The response will include `managee_ids`, which references the data in the `users` top-level key.\n- `manager` (User) - Retrieves the manager of the user this account membership is for. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `possible_managees` (User) - Retrieves a list of users who can become the direct reports of the user this account membership is for. The response will include `possible_managee_ids`, which references the data in the `users` top-level key.\n- `possible_managers` (User) - Retrieves a list of users who can be set as the manager of the user this account membership is for. The response will include `possible_manager_ids`, which references the data in the `users` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships for the user this account membership is for, which represent skills assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key.\n- `user` (User) - Retrieves the user for this account membership. The response will include `user_id`, which references the data in the `users` top-level key."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"only_active","in":"query","schemaId":"schema_305","description":"Only includes users with an active membership (disabled_at is null)."},{"name":"only_inactive","in":"query","schemaId":"schema_305","description":"Only includes users with an inactive membership (disabled_at is not null)."},{"name":"optional_fields","in":"query","schemaId":"schema_326","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `bill_rate:asc`, `bill_rate:desc`, `cost_rate:asc`, `cost_rate:desc`, `created_at:asc`, `created_at:desc`, `full_name:asc`, `full_name:desc`, `permission:asc`, `permission:desc`, `role:asc`, `role:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"search","in":"query","schemaId":"schema_304"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"with_skills","in":"query","schemaId":"schema_304","description":"Return only account memberships for users with the specified skills and levels. Provide the skill IDs,\nlevel numbers for each skill (if applicable), and whether to filter using AND or OR logic.\nYou can specify multiple skills and multiple levels.\n\nFormat as `{\"ids\":[skill_id,skill_id],\"skill_id\":[level,level],\"skill_id\":[level],\"operation\":\"\"}` .\n\nExample 1 - Filter by two skills, one which has levels and one which doesn't. Apply AND logic.\n\n`{\"ids\":[234,789],\"234\":[3,4],\"operation\":\"and\"}`\n\nExample 2 - Filter by two skills, both of which have levels. Apply OR logic.\n\n`{\"ids\":[123,456],\"123\":[4,5],\"456\":[1,2],\"operation\":\"or\"}`."},{"name":"with_user_ids","in":"query","schemaId":"schema_304","description":"Only includes account memberships for the specified user IDs. For example, '1,2,3'."}],"pointer":"/paths/~1account_memberships/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"by_full_name","in":"query","schemaId":"schema_304"},{"name":"by_user_id","in":"query","schemaId":"schema_313"},{"name":"can_log_in","in":"query","schemaId":"schema_305"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"only_active","in":"query","schemaId":"schema_305"},{"name":"only_inactive","in":"query","schemaId":"schema_305"},{"name":"optional_fields","in":"query","schemaId":"schema_326","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"search","in":"query","schemaId":"schema_304"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"with_skills","in":"query","required":false,"schemaId":"schema_304"},{"name":"with_user_ids","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_memberships","href":"account-memberships/get account memberships","openApiOperationId":"Get Account Memberships","summary":"Fetching a list of Account Memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Account Memberships have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}},"schemaId":"schema_327"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_memberships/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_327","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_memberships"},{"label":"Fetching a single Account Membership","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-memberships/get account membership","routeSlug":"/kantata/specification/account-memberships/get account membership","metadata":{"seo":{"title":"Fetching a single Account Membership","description":"This endpoint returns structured Account Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the account_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Account Membership","name":"Fetching a single Account Membership","isWebhook":false,"pointer":"/paths/~1account_memberships~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Account Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1account_memberships~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `backup_approver_associations` (BackupApproverAssociation) - Retrieves the [backup approver associations](/tag/Backup-Approver-Associations) for the user this account membership is for, which represent a backup time approver for a specific date range. The response will include `backup_approver_association_ids`, which references the data in the `backup_approver_associations` top-level key.\n- `cost_rates` (CostRate) - Retrieves all the cost rates in different currencies for the user this account membership is for. The response will include `cost_rate_ids`, which references the data in the `cost_rates` top-level key.\n- `default_role` (Role) - Retrieves the default role, if any, for this account membership. The response will include `default_role_id`, which references the data in the `roles` top-level key.\n- `effective_workweek` (Workweek) - Retrieves the workweek that is in effect today for the user this account membership is for. The response will include `effective_workweek_id`, which references the data in the `workweeks` top-level key.\n- `future_billable_utilizations` (BillableUtilization) - Retrieves the future billable utilizations for the user this account membership is for. The response will include `future_billable_utilization_ids`, which references the data in the `billable_utilizations` top-level key.\n- `managees` (User) - Retrieves the direct reports of the user this account membership is for. The response will include `managee_ids`, which references the data in the `users` top-level key.\n- `manager` (User) - Retrieves the manager of the user this account membership is for. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `possible_managees` (User) - Retrieves a list of users who can become the direct reports of the user this account membership is for. The response will include `possible_managee_ids`, which references the data in the `users` top-level key.\n- `possible_managers` (User) - Retrieves a list of users who can be set as the manager of the user this account membership is for. The response will include `possible_manager_ids`, which references the data in the `users` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships for the user this account membership is for, which represent skills assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key.\n- `user` (User) - Retrieves the user for this account membership. The response will include `user_id`, which references the data in the `users` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_326","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1account_memberships~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_326","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_memberships/{id}","href":"account-memberships/get account membership","openApiOperationId":"Get Account Membership","summary":"Fetching a single Account Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Account Membership has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}},"schemaId":"schema_327"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_memberships~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_327","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_memberships/{id}"},{"label":"Updating an existing Account Membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-memberships/update account membership","routeSlug":"/kantata/specification/account-memberships/update account membership","metadata":{"seo":{"title":"Updating an existing Account Membership","description":"This endpoint returns structured Account Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the account_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Account Membership","name":"Updating an existing Account Membership","isWebhook":false,"pointer":"/paths/~1account_memberships~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Account Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1account_memberships~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `backup_approver_associations` (BackupApproverAssociation) - Retrieves the [backup approver associations](/tag/Backup-Approver-Associations) for the user this account membership is for, which represent a backup time approver for a specific date range. The response will include `backup_approver_association_ids`, which references the data in the `backup_approver_associations` top-level key.\n- `cost_rates` (CostRate) - Retrieves all the cost rates in different currencies for the user this account membership is for. The response will include `cost_rate_ids`, which references the data in the `cost_rates` top-level key.\n- `default_role` (Role) - Retrieves the default role, if any, for this account membership. The response will include `default_role_id`, which references the data in the `roles` top-level key.\n- `effective_workweek` (Workweek) - Retrieves the workweek that is in effect today for the user this account membership is for. The response will include `effective_workweek_id`, which references the data in the `workweeks` top-level key.\n- `future_billable_utilizations` (BillableUtilization) - Retrieves the future billable utilizations for the user this account membership is for. The response will include `future_billable_utilization_ids`, which references the data in the `billable_utilizations` top-level key.\n- `managees` (User) - Retrieves the direct reports of the user this account membership is for. The response will include `managee_ids`, which references the data in the `users` top-level key.\n- `manager` (User) - Retrieves the manager of the user this account membership is for. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `possible_managees` (User) - Retrieves a list of users who can become the direct reports of the user this account membership is for. The response will include `possible_managee_ids`, which references the data in the `users` top-level key.\n- `possible_managers` (User) - Retrieves a list of users who can be set as the manager of the user this account membership is for. The response will include `possible_manager_ids`, which references the data in the `users` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships for the user this account membership is for, which represent skills assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key.\n- `user` (User) - Retrieves the user for this account membership. The response will include `user_id`, which references the data in the `users` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_326","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1account_memberships~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328","pointer":"/paths/~1account_memberships~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/account_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_326","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_328"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_memberships/{id}","href":"account-memberships/update account membership","openApiOperationId":"Update Account Membership","summary":"Updating an existing Account Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_328"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Membership has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}},"schemaId":"schema_327"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_memberships~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_327","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_memberships/{id}"},{"label":"Remove a user from an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-memberships/delete account membership","routeSlug":"/kantata/specification/account-memberships/delete account membership","metadata":{"seo":{"title":"Remove a user from an account","description":"This removes the member from your account and places them on a separate Kantata OX account. It is importantto know that the account owner cannot be removed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Account Membership","name":"Remove a user from an account","isWebhook":false,"pointer":"/paths/~1account_memberships~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a user from an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This removes the member from your account and places them on a separate Kantata OX account. It is important"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to know that the account owner cannot be removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Since the removed member gets their on own separate Kantata OX account,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they will remain on existing projects but will be View Only and no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"longer be able to create projects in your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We suggest "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" an account member over removing them since it revokes their ability to access"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"your account and they will no longer have access to projects for which they were contributing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1account_memberships~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/account_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/account_memberships/{id}","href":"account-memberships/delete account membership","openApiOperationId":"Delete Account Membership","summary":"Remove a user from an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Account Membership has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_memberships~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_memberships/{id}"},{"label":"Make a user inactive","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-memberships/deactivate account membership","routeSlug":"/kantata/specification/account-memberships/deactivate account membership","metadata":{"seo":{"title":"Make a user inactive","description":"Disables a user in an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Deactivate Account Membership","name":"Make a user inactive","isWebhook":false,"pointer":"/paths/~1account_memberships~1{id}~1disable/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Make a user inactive","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disables a user in an account"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1account_memberships~1{id}~1disable/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `backup_approver_associations` (BackupApproverAssociation) - Retrieves the [backup approver associations](/tag/Backup-Approver-Associations) for the user this account membership is for, which represent a backup time approver for a specific date range. The response will include `backup_approver_association_ids`, which references the data in the `backup_approver_associations` top-level key.\n- `cost_rates` (CostRate) - Retrieves all the cost rates in different currencies for the user this account membership is for. The response will include `cost_rate_ids`, which references the data in the `cost_rates` top-level key.\n- `default_role` (Role) - Retrieves the default role, if any, for this account membership. The response will include `default_role_id`, which references the data in the `roles` top-level key.\n- `effective_workweek` (Workweek) - Retrieves the workweek that is in effect today for the user this account membership is for. The response will include `effective_workweek_id`, which references the data in the `workweeks` top-level key.\n- `future_billable_utilizations` (BillableUtilization) - Retrieves the future billable utilizations for the user this account membership is for. The response will include `future_billable_utilization_ids`, which references the data in the `billable_utilizations` top-level key.\n- `managees` (User) - Retrieves the direct reports of the user this account membership is for. The response will include `managee_ids`, which references the data in the `users` top-level key.\n- `manager` (User) - Retrieves the manager of the user this account membership is for. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `possible_managees` (User) - Retrieves a list of users who can become the direct reports of the user this account membership is for. The response will include `possible_managee_ids`, which references the data in the `users` top-level key.\n- `possible_managers` (User) - Retrieves a list of users who can be set as the manager of the user this account membership is for. The response will include `possible_manager_ids`, which references the data in the `users` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships for the user this account membership is for, which represent skills assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key.\n- `user` (User) - Retrieves the user for this account membership. The response will include `user_id`, which references the data in the `users` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_326","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1account_memberships~1{id}~1disable/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/account_memberships/{id}/disable","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_326","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_memberships/{id}/disable","href":"account-memberships/deactivate account membership","openApiOperationId":"Deactivate Account Membership","summary":"Make a user inactive"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Membership has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}},"schemaId":"schema_327"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_memberships~1{id}~1disable/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_327","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_memberships/{id}/disable"},{"label":"Make a user active","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/account-memberships/activate account membership","routeSlug":"/kantata/specification/account-memberships/activate account membership","metadata":{"seo":{"title":"Make a user active","description":"Enables a user in an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Activate Account Membership","name":"Make a user active","isWebhook":false,"pointer":"/paths/~1account_memberships~1{id}~1enable/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Make a user active","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables a user in an account"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1account_memberships~1{id}~1enable/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `backup_approver_associations` (BackupApproverAssociation) - Retrieves the [backup approver associations](/tag/Backup-Approver-Associations) for the user this account membership is for, which represent a backup time approver for a specific date range. The response will include `backup_approver_association_ids`, which references the data in the `backup_approver_associations` top-level key.\n- `cost_rates` (CostRate) - Retrieves all the cost rates in different currencies for the user this account membership is for. The response will include `cost_rate_ids`, which references the data in the `cost_rates` top-level key.\n- `default_role` (Role) - Retrieves the default role, if any, for this account membership. The response will include `default_role_id`, which references the data in the `roles` top-level key.\n- `effective_workweek` (Workweek) - Retrieves the workweek that is in effect today for the user this account membership is for. The response will include `effective_workweek_id`, which references the data in the `workweeks` top-level key.\n- `future_billable_utilizations` (BillableUtilization) - Retrieves the future billable utilizations for the user this account membership is for. The response will include `future_billable_utilization_ids`, which references the data in the `billable_utilizations` top-level key.\n- `managees` (User) - Retrieves the direct reports of the user this account membership is for. The response will include `managee_ids`, which references the data in the `users` top-level key.\n- `manager` (User) - Retrieves the manager of the user this account membership is for. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `possible_managees` (User) - Retrieves a list of users who can become the direct reports of the user this account membership is for. The response will include `possible_managee_ids`, which references the data in the `users` top-level key.\n- `possible_managers` (User) - Retrieves a list of users who can be set as the manager of the user this account membership is for. The response will include `possible_manager_ids`, which references the data in the `users` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships for the user this account membership is for, which represent skills assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key.\n- `user` (User) - Retrieves the user for this account membership. The response will include `user_id`, which references the data in the `users` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_326","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1account_memberships~1{id}~1enable/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/account_memberships/{id}/enable","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_326","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_memberships/{id}/enable","href":"account-memberships/activate account membership","openApiOperationId":"Activate Account Membership","summary":"Make a user active"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Membership has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}},"schemaId":"schema_327"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_memberships~1{id}~1enable/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_327","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_memberships/{id}/enable"}],"content":{"contentType":"group","meta":{"name":"Account Memberships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Memberships","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each user on an account will have an account membership that describes their relationship to the account. When you add a user"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to an account, create a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_membership"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When you remove a user from an account, delete their account_membership record."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_memberships","summary":"Fetching a list of Account Memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-memberships/get account memberships","deprecated":false},{"title":"/account_memberships/{id}","summary":"Fetching a single Account Membership","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-memberships/get account membership","deprecated":false},{"title":"/account_memberships/{id}","summary":"Updating an existing Account Membership","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-memberships/update account membership","deprecated":false},{"title":"/account_memberships/{id}","summary":"Remove a user from an account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-memberships/delete account membership","deprecated":false},{"title":"/account_memberships/{id}/disable","summary":"Make a user inactive","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-memberships/deactivate account membership","deprecated":false},{"title":"/account_memberships/{id}/enable","summary":"Make a user active","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-memberships/activate account membership","deprecated":false}]}]}]}]}},{"type":"group","label":"Backup Approver Associations","link":"/kantata/specification/backup-approver-associations","routeSlug":"/kantata/specification/backup-approver-associations","items":[{"label":"Fetching a list of Backup Approver Associations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/backup-approver-associations/get backup approver associations","routeSlug":"/kantata/specification/backup-approver-associations/get backup approver associations","metadata":{"seo":{"title":"Fetching a list of Backup Approver Associations","description":"The index endpoint only returns backup approver associations that are visible to the user.Backup approver associations are only visible to account members."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Backup Approver Associations","name":"Fetching a list of Backup Approver Associations","isWebhook":false,"pointer":"/paths/~1backup_approver_associations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Backup Approver Associations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index endpoint only returns backup approver associations that are visible to the user."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Backup approver associations are only visible to account members."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Backup Approver Association objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backup_approver_associations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `approver` (User) - The user who would normally approve time.\n- `backup_approver` (User) - The user who will be approving time in place of the normal approver."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1backup_approver_associations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/backup_approver_associations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/backup_approver_associations","href":"backup-approver-associations/get backup approver associations","openApiOperationId":"Get Backup Approver Associations","summary":"Fetching a list of Backup Approver Associations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Backup Approver Associations have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_329"}},"schemaId":"schema_329"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1backup_approver_associations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_329","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_329"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/backup_approver_associations"},{"label":"Creating a new Backup Approver Association","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/backup-approver-associations/create backup approver association","routeSlug":"/kantata/specification/backup-approver-associations/create backup approver association","metadata":{"seo":{"title":"Creating a new Backup Approver Association","description":"This endpoint returns structured Backup Approver Association objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the backup_approver_associations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Backup Approver Association","name":"Creating a new Backup Approver Association","isWebhook":false,"pointer":"/paths/~1backup_approver_associations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Backup Approver Association","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Backup Approver Association objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backup_approver_associations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `approver` (User) - The user who would normally approve time.\n- `backup_approver` (User) - The user who will be approving time in place of the normal approver."}],"pointer":"/paths/~1backup_approver_associations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_330"}},"schemaId":"schema_330","pointer":"/paths/~1backup_approver_associations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/backup_approver_associations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_330"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/backup_approver_associations","href":"backup-approver-associations/create backup approver association","openApiOperationId":"Create Backup Approver Association","summary":"Creating a new Backup Approver Association"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_330","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_330"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Backup Approver Association has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_329"}},"schemaId":"schema_329"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1backup_approver_associations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_329","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_329"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/backup_approver_associations"},{"label":"Fetching a single Backup Approver Association","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/backup-approver-associations/get backup approver association","routeSlug":"/kantata/specification/backup-approver-associations/get backup approver association","metadata":{"seo":{"title":"Fetching a single Backup Approver Association","description":"This endpoint returns structured Backup Approver Association objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the backup_approver_associations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Backup Approver Association","name":"Fetching a single Backup Approver Association","isWebhook":false,"pointer":"/paths/~1backup_approver_associations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Backup Approver Association","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Backup Approver Association objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backup_approver_associations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1backup_approver_associations~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `approver` (User) - The user who would normally approve time.\n- `backup_approver` (User) - The user who will be approving time in place of the normal approver."}],"pointer":"/paths/~1backup_approver_associations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/backup_approver_associations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/backup_approver_associations/{id}","href":"backup-approver-associations/get backup approver association","openApiOperationId":"Get Backup Approver Association","summary":"Fetching a single Backup Approver Association"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Backup Approver Association has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_329"}},"schemaId":"schema_329"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1backup_approver_associations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_329","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_329"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/backup_approver_associations/{id}"},{"label":"Updating an existing Backup Approver Association","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/backup-approver-associations/update backup approver association","routeSlug":"/kantata/specification/backup-approver-associations/update backup approver association","metadata":{"seo":{"title":"Updating an existing Backup Approver Association","description":"This endpoint returns structured Backup Approver Association objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the backup_approver_associations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Backup Approver Association","name":"Updating an existing Backup Approver Association","isWebhook":false,"pointer":"/paths/~1backup_approver_associations~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Backup Approver Association","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Backup Approver Association objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backup_approver_associations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1backup_approver_associations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `approver` (User) - The user who would normally approve time.\n- `backup_approver` (User) - The user who will be approving time in place of the normal approver."}],"pointer":"/paths/~1backup_approver_associations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_331"}},"schemaId":"schema_331","pointer":"/paths/~1backup_approver_associations~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/backup_approver_associations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_331"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/backup_approver_associations/{id}","href":"backup-approver-associations/update backup approver association","openApiOperationId":"Update Backup Approver Association","summary":"Updating an existing Backup Approver Association"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_331","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_331"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Backup Approver Association has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_329"}},"schemaId":"schema_329"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1backup_approver_associations~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_329","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_329"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/backup_approver_associations/{id}"},{"label":"Deleting an existing Backup Approver Association","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/backup-approver-associations/delete backup approver association","routeSlug":"/kantata/specification/backup-approver-associations/delete backup approver association","metadata":{"seo":{"title":"Deleting an existing Backup Approver Association","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Backup Approver Association","name":"Deleting an existing Backup Approver Association","isWebhook":false,"pointer":"/paths/~1backup_approver_associations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Backup Approver Association","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1backup_approver_associations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/backup_approver_associations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/backup_approver_associations/{id}","href":"backup-approver-associations/delete backup approver association","openApiOperationId":"Delete Backup Approver Association","summary":"Deleting an existing Backup Approver Association"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Backup Approver Association has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1backup_approver_associations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/backup_approver_associations/{id}"}],"content":{"contentType":"group","meta":{"name":"Backup Approver Associations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Backup Approver Associations","showPageActions":true},{"nodeType":"markdoc","content":"A Backup Approver Association represents the relationship of a delegated approver to a range of specific dates.\nApproval responsibilities are delegated to a backup approver."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/backup_approver_associations","summary":"Fetching a list of Backup Approver Associations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/backup-approver-associations/get backup approver associations","deprecated":false},{"title":"/backup_approver_associations","summary":"Creating a new Backup Approver Association","prefix":{"name":"post","color":"post"},"badges":[],"link":"/backup-approver-associations/create backup approver association","deprecated":false},{"title":"/backup_approver_associations/{id}","summary":"Fetching a single Backup Approver Association","prefix":{"name":"get","color":"get"},"badges":[],"link":"/backup-approver-associations/get backup approver association","deprecated":false},{"title":"/backup_approver_associations/{id}","summary":"Updating an existing Backup Approver Association","prefix":{"name":"put","color":"put"},"badges":[],"link":"/backup-approver-associations/update backup approver association","deprecated":false},{"title":"/backup_approver_associations/{id}","summary":"Deleting an existing Backup Approver Association","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/backup-approver-associations/delete backup approver association","deprecated":false}]}]}]}]}},{"type":"group","label":"Billable Utilizations","link":"/kantata/specification/billable-utilizations","routeSlug":"/kantata/specification/billable-utilizations","items":[{"label":"Fetching a list of Billable Utilizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/billable-utilizations/get billable utilizations","routeSlug":"/kantata/specification/billable-utilizations/get billable utilizations","metadata":{"seo":{"title":"Fetching a list of Billable Utilizations","description":"This endpoint returns structured Billable Utilization objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the billable_utilizations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Billable Utilizations","name":"Fetching a list of Billable Utilizations","isWebhook":false,"pointer":"/paths/~1billable_utilizations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Billable Utilizations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Billable Utilization objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable_utilizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - The account membership for the user with whom the billable utilization is associated.\n- `creator` (User) - The user who created the billable utilization."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1billable_utilizations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billable_utilizations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/billable_utilizations","href":"billable-utilizations/get billable utilizations","openApiOperationId":"Get Billable Utilizations","summary":"Fetching a list of Billable Utilizations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Billable Utilizations have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}},"schemaId":"schema_332"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1billable_utilizations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_332","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/billable_utilizations"},{"label":"Creating a new Billable Utilization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/billable-utilizations/create billable utilization","routeSlug":"/kantata/specification/billable-utilizations/create billable utilization","metadata":{"seo":{"title":"Creating a new Billable Utilization","description":"This endpoint returns structured Billable Utilization objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the billable_utilizations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Billable Utilization","name":"Creating a new Billable Utilization","isWebhook":false,"pointer":"/paths/~1billable_utilizations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Billable Utilization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Billable Utilization objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable_utilizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - The account membership for the user with whom the billable utilization is associated.\n- `creator` (User) - The user who created the billable utilization."}],"pointer":"/paths/~1billable_utilizations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_333"}},"schemaId":"schema_333","pointer":"/paths/~1billable_utilizations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billable_utilizations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_333"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/billable_utilizations","href":"billable-utilizations/create billable utilization","openApiOperationId":"Create Billable Utilization","summary":"Creating a new Billable Utilization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_333","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_333"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Billable Utilization has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}},"schemaId":"schema_332"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1billable_utilizations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_332","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/billable_utilizations"},{"label":"Fetching a single Billable Utilization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/billable-utilizations/get billable utilization","routeSlug":"/kantata/specification/billable-utilizations/get billable utilization","metadata":{"seo":{"title":"Fetching a single Billable Utilization","description":"This endpoint returns structured Billable Utilization objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the billable_utilizations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Billable Utilization","name":"Fetching a single Billable Utilization","isWebhook":false,"pointer":"/paths/~1billable_utilizations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Billable Utilization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Billable Utilization objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable_utilizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1billable_utilizations~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - The account membership for the user with whom the billable utilization is associated.\n- `creator` (User) - The user who created the billable utilization."}],"pointer":"/paths/~1billable_utilizations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billable_utilizations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/billable_utilizations/{id}","href":"billable-utilizations/get billable utilization","openApiOperationId":"Get Billable Utilization","summary":"Fetching a single Billable Utilization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Billable Utilization has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}},"schemaId":"schema_332"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1billable_utilizations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_332","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/billable_utilizations/{id}"},{"label":"Updating an existing Billable Utilization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/billable-utilizations/update billable utilization","routeSlug":"/kantata/specification/billable-utilizations/update billable utilization","metadata":{"seo":{"title":"Updating an existing Billable Utilization","description":"This endpoint returns structured Billable Utilization objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the billable_utilizations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Billable Utilization","name":"Updating an existing Billable Utilization","isWebhook":false,"pointer":"/paths/~1billable_utilizations~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Billable Utilization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Billable Utilization objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable_utilizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1billable_utilizations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - The account membership for the user with whom the billable utilization is associated.\n- `creator` (User) - The user who created the billable utilization."}],"pointer":"/paths/~1billable_utilizations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_334"}},"schemaId":"schema_334","pointer":"/paths/~1billable_utilizations~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/billable_utilizations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_334"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/billable_utilizations/{id}","href":"billable-utilizations/update billable utilization","openApiOperationId":"Update Billable Utilization","summary":"Updating an existing Billable Utilization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_334","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_334"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Billable Utilization has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}},"schemaId":"schema_332"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1billable_utilizations~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_332","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/billable_utilizations/{id}"},{"label":"Deleting an existing Billable Utilization","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/billable-utilizations/delete billable utilization","routeSlug":"/kantata/specification/billable-utilizations/delete billable utilization","metadata":{"seo":{"title":"Deleting an existing Billable Utilization","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Billable Utilization","name":"Deleting an existing Billable Utilization","isWebhook":false,"pointer":"/paths/~1billable_utilizations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Billable Utilization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1billable_utilizations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/billable_utilizations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/billable_utilizations/{id}","href":"billable-utilizations/delete billable utilization","openApiOperationId":"Delete Billable Utilization","summary":"Deleting an existing Billable Utilization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Billable Utilization has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1billable_utilizations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/billable_utilizations/{id}"}],"content":{"contentType":"group","meta":{"name":"Billable Utilizations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billable Utilizations","showPageActions":true},{"nodeType":"markdoc","content":"Represents the billable utilization target for an account member. Each record has an effective date; the active billable utilization is the one with the most recent effective date. These endpoints are only accessible to users who are Administrators on the account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/billable_utilizations","summary":"Fetching a list of Billable Utilizations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billable-utilizations/get billable utilizations","deprecated":false},{"title":"/billable_utilizations","summary":"Creating a new Billable Utilization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billable-utilizations/create billable utilization","deprecated":false},{"title":"/billable_utilizations/{id}","summary":"Fetching a single Billable Utilization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billable-utilizations/get billable utilization","deprecated":false},{"title":"/billable_utilizations/{id}","summary":"Updating an existing Billable Utilization","prefix":{"name":"put","color":"put"},"badges":[],"link":"/billable-utilizations/update billable utilization","deprecated":false},{"title":"/billable_utilizations/{id}","summary":"Deleting an existing Billable Utilization","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/billable-utilizations/delete billable utilization","deprecated":false}]}]}]}]}},{"type":"group","label":"Cost Rates","link":"/kantata/specification/cost-rates","routeSlug":"/kantata/specification/cost-rates","items":[{"label":"Get Cost Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/cost-rates/get cost rates","routeSlug":"/kantata/specification/cost-rates/get cost rates","metadata":{"seo":{"title":"Get Cost Rates","description":"This endpoint returns structured Cost Rate objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the cost_rates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Cost Rates","name":"Get Cost Rates","isWebhook":false,"pointer":"/paths/~1cost_rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cost Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Cost Rate objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cost_rates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - The account membership associated with the cost rate."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_335","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1cost_rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cost_rates","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_335"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/cost_rates","href":"cost-rates/get cost rates","openApiOperationId":"Get Cost Rates","summary":"Get Cost Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Cost Rates have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}},"schemaId":"schema_336"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1cost_rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_336","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/cost_rates"},{"label":"Creating one or many Cost Rates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/cost-rates/create cost rate","routeSlug":"/kantata/specification/cost-rates/create cost rate","metadata":{"seo":{"title":"Creating one or many Cost Rates","description":"Creates a new cost rate for a specified account membership and currency. If a cost rate already existsfor the specified account membership and currency, it will be overridden, effectively making this anupdate request as well. Up to 100 cost rates can be created or updated at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Cost Rate","name":"Creating one or many Cost Rates","isWebhook":false,"pointer":"/paths/~1cost_rates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating one or many Cost Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new cost rate for a specified account membership and currency. If a cost rate already exists"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the specified account membership and currency, it will be overridden, effectively making this an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update request as well. Up to 100 cost rates can be created or updated at once."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Updating a cost rate will set the cost rate for future work. Existing time entries will not be affected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Cost Rate objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cost_rates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - The account membership associated with the cost rate."}],"pointer":"/paths/~1cost_rates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_337"}},"schemaId":"schema_337","pointer":"/paths/~1cost_rates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cost_rates","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_337"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/cost_rates","href":"cost-rates/create cost rate","openApiOperationId":"Create Cost Rate","summary":"Creating one or many Cost Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_337","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_337"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cost Rate has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}},"schemaId":"schema_336"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1cost_rates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_336","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/cost_rates"},{"label":"Updating an existing Cost Rate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/cost-rates/update cost rate","routeSlug":"/kantata/specification/cost-rates/update cost rate","metadata":{"seo":{"title":"Updating an existing Cost Rate","description":"This endpoint returns structured Cost Rate objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the cost_rates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Cost Rate","name":"Updating an existing Cost Rate","isWebhook":false,"pointer":"/paths/~1cost_rates~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Cost Rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Cost Rate objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cost_rates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1cost_rates~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - The account membership associated with the cost rate."}],"pointer":"/paths/~1cost_rates~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_338"}},"schemaId":"schema_338","pointer":"/paths/~1cost_rates~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/cost_rates/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_338"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/cost_rates/{id}","href":"cost-rates/update cost rate","openApiOperationId":"Update Cost Rate","summary":"Updating an existing Cost Rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_338","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_338"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cost Rate has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}},"schemaId":"schema_336"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1cost_rates~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_336","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/cost_rates/{id}"},{"label":"Deleting an existing Cost Rate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/cost-rates/delete cost rate","routeSlug":"/kantata/specification/cost-rates/delete cost rate","metadata":{"seo":{"title":"Deleting an existing Cost Rate","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Cost Rate","name":"Deleting an existing Cost Rate","isWebhook":false,"pointer":"/paths/~1cost_rates~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Cost Rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1cost_rates~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cost_rates/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/cost_rates/{id}","href":"cost-rates/delete cost rate","openApiOperationId":"Delete Cost Rate","summary":"Deleting an existing Cost Rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Cost Rate has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1cost_rates~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/cost_rates/{id}"}],"content":{"contentType":"group","meta":{"name":"Cost Rates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cost Rates","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Rate represents the hourly cost for an account member, specified in a specific currency. A cost rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the same currency as the account default currency is called the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default cost rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cost_rates","summary":"Get Cost Rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cost-rates/get cost rates","deprecated":false},{"title":"/cost_rates","summary":"Creating one or many Cost Rates","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cost-rates/create cost rate","deprecated":false},{"title":"/cost_rates/{id}","summary":"Updating an existing Cost Rate","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cost-rates/update cost rate","deprecated":false},{"title":"/cost_rates/{id}","summary":"Deleting an existing Cost Rate","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cost-rates/delete cost rate","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Branding","link":"/kantata/specification/custom-branding","routeSlug":"/kantata/specification/custom-branding","items":[{"label":"Fetch Custom Branding Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-branding/get custom branding settings","routeSlug":"/kantata/specification/custom-branding/get custom branding settings","metadata":{"seo":{"title":"Fetch Custom Branding Settings","description":"Retrieve custom branding information for the current user's account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Custom Branding Settings","name":"Fetch Custom Branding Settings","isWebhook":false,"pointer":"/paths/~1custom_branding/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch Custom Branding Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve custom branding information for the current user's account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Branding (Private Label) objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1custom_branding/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom_branding","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_branding","href":"custom-branding/get custom branding settings","openApiOperationId":"Get Custom Branding Settings","summary":"Fetch Custom Branding Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Custom Branding (Private Label)s have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339"}},"schemaId":"schema_339"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_branding/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_339","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_branding"}],"content":{"contentType":"group","meta":{"name":"Custom Branding"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Branding","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custom_branding","summary":"Fetch Custom Branding Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-branding/get custom branding settings","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization Memberships","link":"/kantata/specification/organization-memberships","routeSlug":"/kantata/specification/organization-memberships","items":[{"label":"Fetching a list of Organization Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/organization-memberships/get organization memberships","routeSlug":"/kantata/specification/organization-memberships/get organization memberships","metadata":{"seo":{"title":"Fetching a list of Organization Memberships","description":"This endpoint returns structured Organization Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the organization_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Organization Memberships","name":"Fetching a list of Organization Memberships","isWebhook":false,"pointer":"/paths/~1organization_memberships/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Organization Memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Organization Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organization_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"department_id","in":"query","schemaId":"schema_313","description":"Returns only organization memberships with the specified department ID."},{"name":"geography_id","in":"query","schemaId":"schema_313","description":"Returns only organization memberships with the specified geography ID."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `department` (Organization) - The department of the associated member.\n- `geography` (Organization) - The geography of the associated member."},{"name":"member_id","in":"query","schemaId":"schema_313","description":"Returns only organization memberships with the specified member ID."},{"name":"member_type","in":"query","schemaId":"schema_304","description":"Returns only organization memberships with the specified member type (user or workspace)."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"primary","in":"query","schemaId":"schema_305","description":"Return only the organization membership that is set as the primary for the object (`true`) or only the organization memberships that\nare not the primary (`false`). This filter requires the primary organization feature."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1organization_memberships/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organization_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"department_id","in":"query","schemaId":"schema_313"},{"name":"geography_id","in":"query","schemaId":"schema_313"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"member_id","in":"query","schemaId":"schema_313"},{"name":"member_type","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"primary","in":"query","schemaId":"schema_305"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/organization_memberships","href":"organization-memberships/get organization memberships","openApiOperationId":"Get Organization Memberships","summary":"Fetching a list of Organization Memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Organization Memberships have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1organization_memberships/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/organization_memberships"},{"label":"Creating a new Organization Membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/organization-memberships/create organization membership","routeSlug":"/kantata/specification/organization-memberships/create organization membership","metadata":{"seo":{"title":"Creating a new Organization Membership","description":"Applies an organization to a workspace (project) or user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Organization Membership","name":"Creating a new Organization Membership","isWebhook":false,"pointer":"/paths/~1organization_memberships/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Organization Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies an organization to a workspace (project) or user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"organization_memberships\": [\n {\n \"geography_id\": 123,\n \"department_id\": 456,\n \"member_id\": 111,\n \"member_type\": \"User\"\n },\n {\n \"geography_id\": 123,\n \"department_id\": 456,\n \"member_id\": 222,\n \"member_type\": \"User\"\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"organization_memberships\": [\n {\n \"geography_id\": 123,\n \"department_id\": 456,\n \"member_id\": 111,\n \"member_type\": \"User\"\n },\n {\n \"geography_id\": 123,\n \"department_id\": 456,\n \"member_id\": 222,\n \"member_type\": \"User\"\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Organization Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organization_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `department` (Organization) - The department of the associated member.\n- `geography` (Organization) - The geography of the associated member."}],"pointer":"/paths/~1organization_memberships/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_341"}},"schemaId":"schema_341","pointer":"/paths/~1organization_memberships/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organization_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_341"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/organization_memberships","href":"organization-memberships/create organization membership","openApiOperationId":"Create Organization Membership","summary":"Creating a new Organization Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_341","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_341"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Organization Membership has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1organization_memberships/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/organization_memberships"},{"label":"Fetching a single Organization Membership","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/organization-memberships/get organization membership","routeSlug":"/kantata/specification/organization-memberships/get organization membership","metadata":{"seo":{"title":"Fetching a single Organization Membership","description":"This endpoint returns structured Organization Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the organization_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Organization Membership","name":"Fetching a single Organization Membership","isWebhook":false,"pointer":"/paths/~1organization_memberships~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Organization Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Organization Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organization_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1organization_memberships~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `department` (Organization) - The department of the associated member.\n- `geography` (Organization) - The geography of the associated member."}],"pointer":"/paths/~1organization_memberships~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organization_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/organization_memberships/{id}","href":"organization-memberships/get organization membership","openApiOperationId":"Get Organization Membership","summary":"Fetching a single Organization Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Organization Membership has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1organization_memberships~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/organization_memberships/{id}"},{"label":"Updating an existing Organization Membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/organization-memberships/update organization membership","routeSlug":"/kantata/specification/organization-memberships/update organization membership","metadata":{"seo":{"title":"Updating an existing Organization Membership","description":"This endpoint returns structured Organization Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the organization_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Organization Membership","name":"Updating an existing Organization Membership","isWebhook":false,"pointer":"/paths/~1organization_memberships~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Organization Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Organization Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organization_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1organization_memberships~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `department` (Organization) - The department of the associated member.\n- `geography` (Organization) - The geography of the associated member."}],"pointer":"/paths/~1organization_memberships~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_342"}},"schemaId":"schema_342","pointer":"/paths/~1organization_memberships~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organization_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_342"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/organization_memberships/{id}","href":"organization-memberships/update organization membership","openApiOperationId":"Update Organization Membership","summary":"Updating an existing Organization Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_342","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_342"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Organization Membership has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1organization_memberships~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/organization_memberships/{id}"},{"label":"Deleting an existing Organization Membership","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/organization-memberships/delete organization membership","routeSlug":"/kantata/specification/organization-memberships/delete organization membership","metadata":{"seo":{"title":"Deleting an existing Organization Membership","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Organization Membership","name":"Deleting an existing Organization Membership","isWebhook":false,"pointer":"/paths/~1organization_memberships~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Organization Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1organization_memberships~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organization_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/organization_memberships/{id}","href":"organization-memberships/delete organization membership","openApiOperationId":"Delete Organization Membership","summary":"Deleting an existing Organization Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Organization Membership has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1organization_memberships~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/organization_memberships/{id}"}],"content":{"contentType":"group","meta":{"name":"Organization Memberships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization Memberships","showPageActions":true},{"nodeType":"markdoc","content":"An Organization Membership represents the connection of a user and project to an organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organization_memberships","summary":"Fetching a list of Organization Memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-memberships/get organization memberships","deprecated":false},{"title":"/organization_memberships","summary":"Creating a new Organization Membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organization-memberships/create organization membership","deprecated":false},{"title":"/organization_memberships/{id}","summary":"Fetching a single Organization Membership","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-memberships/get organization membership","deprecated":false},{"title":"/organization_memberships/{id}","summary":"Updating an existing Organization Membership","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organization-memberships/update organization membership","deprecated":false},{"title":"/organization_memberships/{id}","summary":"Deleting an existing Organization Membership","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/organization-memberships/delete organization membership","deprecated":false}]}]}]}]}},{"type":"group","label":"Organizations","link":"/kantata/specification/organizations","routeSlug":"/kantata/specification/organizations","items":[{"label":"Fetching a list of Organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/organizations/get organizations","routeSlug":"/kantata/specification/organizations/get organizations","metadata":{"seo":{"title":"Fetching a list of Organizations","description":"This endpoint returns structured Organization objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the organizations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Organizations","name":"Fetching a list of Organizations","isWebhook":false,"pointer":"/paths/~1organizations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Organizations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Organization objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"for_current_user","in":"query","schemaId":"schema_305","description":"Filter for organizations the current user belongs to. The parameter value is ignored (i.e. regardless of the value you supply, including this filter will always filter by organizations the current user belongs to)."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Where organization name is like specified parameter."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_343","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `alphabetical:asc`, `alphabetical:desc`, `created_at:asc`, and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"type","in":"query","schemaId":"schema_304","description":"Where the organization is of a specified type."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1organizations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"for_current_user","in":"query","schemaId":"schema_305"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_343"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"type","in":"query","schemaId":"schema_304"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/organizations","href":"organizations/get organizations","openApiOperationId":"Get Organizations","summary":"Fetching a list of Organizations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Organizations have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}},"schemaId":"schema_344"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1organizations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_344","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/organizations"},{"label":"Creating a new Organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/organizations/create organization","routeSlug":"/kantata/specification/organizations/create organization","metadata":{"seo":{"title":"Creating a new Organization","description":"Creates an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Organization","name":"Creating a new Organization","isWebhook":false,"pointer":"/paths/~1organizations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"organizations\": [\n {\n \"name\": \"Organization\",\n \"parent_id\": 123\n },\n {\n \"name\": \"Organization\",\n \"parent_id\": 123\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"organizations\": [\n {\n \"name\": \"Organization\",\n \"parent_id\": 123\n },\n {\n \"name\": \"Organization\",\n \"parent_id\": 123\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Organization objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_345"}},"schemaId":"schema_345","pointer":"/paths/~1organizations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_345"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/organizations","href":"organizations/create organization","openApiOperationId":"Create Organization","summary":"Creating a new Organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_345","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_345"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Organization has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}},"schemaId":"schema_344"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1organizations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_344","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/organizations"},{"label":"Fetching a single Organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/organizations/get organization","routeSlug":"/kantata/specification/organizations/get organization","metadata":{"seo":{"title":"Fetching a single Organization","description":"This endpoint returns structured Organization objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the organizations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Organization","name":"Fetching a single Organization","isWebhook":false,"pointer":"/paths/~1organizations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Organization objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1organizations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/organizations/{id}","href":"organizations/get organization","openApiOperationId":"Get Organization","summary":"Fetching a single Organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Organization has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}},"schemaId":"schema_344"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1organizations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_344","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/organizations/{id}"},{"label":"Updating an existing Organization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/organizations/update organization","routeSlug":"/kantata/specification/organizations/update organization","metadata":{"seo":{"title":"Updating an existing Organization","description":"This endpoint returns structured Organization objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the organizations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Organization","name":"Updating an existing Organization","isWebhook":false,"pointer":"/paths/~1organizations~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Organization objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1organizations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_346"}},"schemaId":"schema_346","pointer":"/paths/~1organizations~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organizations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_346"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/organizations/{id}","href":"organizations/update organization","openApiOperationId":"Update Organization","summary":"Updating an existing Organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_346","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_346"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Organization has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}},"schemaId":"schema_344"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1organizations~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_344","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/organizations/{id}"},{"label":"Deleting an existing Organization","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/organizations/delete organization","routeSlug":"/kantata/specification/organizations/delete organization","metadata":{"seo":{"title":"Deleting an existing Organization","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Organization","name":"Deleting an existing Organization","isWebhook":false,"pointer":"/paths/~1organizations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1organizations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organizations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/organizations/{id}","href":"organizations/delete organization","openApiOperationId":"Delete Organization","summary":"Deleting an existing Organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Organization has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1organizations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/organizations/{id}"}],"content":{"contentType":"group","meta":{"name":"Organizations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organizations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Organizations feature in Kantata OX is composed of two independent trees:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Department and Geography. Each has its own hierarchy structure."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users and Workspaces are associated to exact positions in these two trees"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Organization-Memberships"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization Memberships"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The corresponding API fields are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geography_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"department_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A user's position in these two trees determines what objects they can see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in Kantata OX—they can see objects associated with every department and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"geography going up the hierarchy from their selected department and geography."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizations","summary":"Fetching a list of Organizations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/get organizations","deprecated":false},{"title":"/organizations","summary":"Creating a new Organization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/create organization","deprecated":false},{"title":"/organizations/{id}","summary":"Fetching a single Organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/get organization","deprecated":false},{"title":"/organizations/{id}","summary":"Updating an existing Organization","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organizations/update organization","deprecated":false},{"title":"/organizations/{id}","summary":"Deleting an existing Organization","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/organizations/delete organization","deprecated":false}]}]}]}]}},{"type":"group","label":"Roles","link":"/kantata/specification/roles","routeSlug":"/kantata/specification/roles","items":[{"label":"Fetching a list of Roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/roles/get roles","routeSlug":"/kantata/specification/roles/get roles","metadata":{"seo":{"title":"Fetching a list of Roles","description":"The Roles endpoint provides a list of all active roles that belong to the account of the user making the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Roles","name":"Fetching a list of Roles","isWebhook":false,"pointer":"/paths/~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Roles endpoint provides a list of all active roles that belong to the account of the user making the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain an array of role objects, sorted alphabetically by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available under the key named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Role objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"for_rate_card","in":"query","schemaId":"schema_313","description":"Only includes roles from a given rate card."},{"name":"for_scenario_rate_card","in":"query","schemaId":"schema_313","description":"Only includes roles that are on the scenario's rate card."},{"name":"for_workspace","in":"query","schemaId":"schema_313","description":"Only includes roles for a specific project ID."},{"name":"for_workspace_rate_card","in":"query","schemaId":"schema_313","description":"Only includes roles that are on the workspace's rate card."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Only includes roles with names that match the search string."},{"name":"not_on_rate_card_set_version","in":"query","schemaId":"schema_313","description":"Only includes roles that are not already on the rate card set version."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"only_active","in":"query","schemaId":"schema_321","description":"Only includes roles that have not been soft-deleted (via deleted_at)."},{"name":"order","in":"query","schemaId":"schema_343","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `alphabetical:asc` and `alphabetical:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/roles","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"for_rate_card","in":"query","schemaId":"schema_313"},{"name":"for_scenario_rate_card","in":"query","schemaId":"schema_313"},{"name":"for_workspace","in":"query","schemaId":"schema_313"},{"name":"for_workspace_rate_card","in":"query","schemaId":"schema_313"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"not_on_rate_card_set_version","in":"query","schemaId":"schema_313"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"only_active","in":"query","schemaId":"schema_321"},{"name":"order","in":"query","schemaId":"schema_343"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/roles","href":"roles/get roles","openApiOperationId":"Get Roles","summary":"Fetching a list of Roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Roles have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}},"schemaId":"schema_347"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_347","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/roles"},{"label":"Creating a new Role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/roles/create role","routeSlug":"/kantata/specification/roles/create role","metadata":{"seo":{"title":"Creating a new Role","description":"This endpoint returns structured Role objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the roles top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Role","name":"Creating a new Role","isWebhook":false,"pointer":"/paths/~1roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Role objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."}],"pointer":"/paths/~1roles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_348"}},"schemaId":"schema_348","pointer":"/paths/~1roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/roles","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_348"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/roles","href":"roles/create role","openApiOperationId":"Create Role","summary":"Creating a new Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_348","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_348"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Role has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}},"schemaId":"schema_347"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1roles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_347","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/roles"},{"label":"Fetching a single Role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/roles/get role","routeSlug":"/kantata/specification/roles/get role","metadata":{"seo":{"title":"Fetching a single Role","description":"This endpoint returns structured Role objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the roles top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Role","name":"Fetching a single Role","isWebhook":false,"pointer":"/paths/~1roles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Role objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1roles~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."}],"pointer":"/paths/~1roles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/roles/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/roles/{id}","href":"roles/get role","openApiOperationId":"Get Role","summary":"Fetching a single Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Role has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}},"schemaId":"schema_347"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1roles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_347","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/roles/{id}"},{"label":"Updating an existing Role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/roles/update role","routeSlug":"/kantata/specification/roles/update role","metadata":{"seo":{"title":"Updating an existing Role","description":"This endpoint returns structured Role objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the roles top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Role","name":"Updating an existing Role","isWebhook":false,"pointer":"/paths/~1roles~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Role objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1roles~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."}],"pointer":"/paths/~1roles~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_349"}},"schemaId":"schema_349","pointer":"/paths/~1roles~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/roles/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_349"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/roles/{id}","href":"roles/update role","openApiOperationId":"Update Role","summary":"Updating an existing Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_349","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_349"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Role has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}},"schemaId":"schema_347"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1roles~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_347","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/roles/{id}"},{"label":"Deleting an existing Role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/roles/delete role","routeSlug":"/kantata/specification/roles/delete role","metadata":{"seo":{"title":"Deleting an existing Role","description":"The Role will be soft-deleted if it is currently in use. If not, it will be removed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Role","name":"Deleting an existing Role","isWebhook":false,"pointer":"/paths/~1roles~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Role will be soft-deleted if it is currently in use. If not, it will be removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1roles~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/roles/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/roles/{id}","href":"roles/delete role","openApiOperationId":"Delete Role","summary":"Deleting an existing Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Role has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1roles~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/roles/{id}"}],"content":{"contentType":"group","meta":{"name":"Roles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roles","showPageActions":true},{"nodeType":"markdoc","content":"A Role represents the main position or title assigned to members on an account. Roles may be associated\nwith account memberships, account invitations, participation, project template assignments, rate card roles,\nrate card versions, resources, or time adjustments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/roles","summary":"Fetching a list of Roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/get roles","deprecated":false},{"title":"/roles","summary":"Creating a new Role","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roles/create role","deprecated":false},{"title":"/roles/{id}","summary":"Fetching a single Role","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/get role","deprecated":false},{"title":"/roles/{id}","summary":"Updating an existing Role","prefix":{"name":"put","color":"put"},"badges":[],"link":"/roles/update role","deprecated":false},{"title":"/roles/{id}","summary":"Deleting an existing Role","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/roles/delete role","deprecated":false}]}]}]}]}},{"type":"group","label":"Skill Categories","link":"/kantata/specification/skill-categories","routeSlug":"/kantata/specification/skill-categories","items":[{"label":"Fetching a list of Skill Categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/skill-categories/get skill categories","routeSlug":"/kantata/specification/skill-categories/get skill categories","metadata":{"seo":{"title":"Fetching a list of Skill Categories","description":"This endpoint returns structured Skill Category objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the skill_categories top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Skill Categories","name":"Fetching a list of Skill Categories","isWebhook":false,"pointer":"/paths/~1skill_categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Skill Categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Skill Category objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skill_categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `skills` (Skill) - The skills associated with each skill category."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Skill category names that are like the specified name."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_343","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `alphabetical:asc` and `alphabetical:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1skill_categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/skill_categories","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_343"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/skill_categories","href":"skill-categories/get skill categories","openApiOperationId":"Get Skill Categories","summary":"Fetching a list of Skill Categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Skill Categories have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_350"}},"schemaId":"schema_350"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1skill_categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_350","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_350"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/skill_categories"}],"content":{"contentType":"group","meta":{"name":"Skill Categories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Skill Categories","showPageActions":true},{"nodeType":"markdoc","content":"A Skill Category represents the classification for a group of skills. Options are 'Skill', 'Language', 'Certification', and 'Other'.\n\nSkill categories are defined by Kantata OX and cannot be modified or deleted."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/skill_categories","summary":"Fetching a list of Skill Categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/skill-categories/get skill categories","deprecated":false}]}]}]}]}},{"type":"group","label":"Skill Memberships","link":"/kantata/specification/skill-memberships","routeSlug":"/kantata/specification/skill-memberships","items":[{"label":"Fetching a list of Skill Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/skill-memberships/get skill memberships","routeSlug":"/kantata/specification/skill-memberships/get skill memberships","metadata":{"seo":{"title":"Fetching a list of Skill Memberships","description":"Returns a list of viewable skill memberships."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Skill Memberships","name":"Fetching a list of Skill Memberships","isWebhook":false,"pointer":"/paths/~1skill_memberships/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Skill Memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of viewable skill memberships."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Skill Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skill_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"active_account_members_only","in":"query","schemaId":"schema_351","description":"Only skill memberships for only active users on the account."},{"name":"by_skill_id","in":"query","schemaId":"schema_313","description":"Only includes associated skill, by the skill ID."},{"name":"by_skill_ids","in":"query","schemaId":"schema_304","description":"Only includes associated skills. Input is a comma separated list of ids or an array."},{"name":"by_skill_name","in":"query","schemaId":"schema_304","description":"Only includes associated skills, by the name of the skill."},{"name":"by_user_name","in":"query","schemaId":"schema_304","description":"Only includes skill memberships assigned to a user, by their full name."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - References the user who has created the skill association.\n- `skill` (Skill) - References the skill assigned to the object.\n- `user` (User) - References the user who has been assigned the skill."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `full_name`, `skill_name:asc`, and `skill_name:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"user_ids","in":"query","schemaId":"schema_352","description":"Only includes skill memberships assigned to a user, by user ID."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Filter for participants of a specific project."}],"pointer":"/paths/~1skill_memberships/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/skill_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"active_account_members_only","in":"query","schemaId":"schema_351"},{"name":"by_skill_id","in":"query","schemaId":"schema_313"},{"name":"by_skill_ids","in":"query","schemaId":"schema_304"},{"name":"by_skill_name","in":"query","schemaId":"schema_304"},{"name":"by_user_name","in":"query","schemaId":"schema_304"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"user_ids","in":"query","schemaId":"schema_352","style":"form","explode":false},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/skill_memberships","href":"skill-memberships/get skill memberships","openApiOperationId":"Get Skill Memberships","summary":"Fetching a list of Skill Memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Skill Memberships have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353"}},"schemaId":"schema_353"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1skill_memberships/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_353","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/skill_memberships"},{"label":"Creating a new Skill Membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/skill-memberships/create skill membership","routeSlug":"/kantata/specification/skill-memberships/create skill membership","metadata":{"seo":{"title":"Creating a new Skill Membership","description":"Adds a skill to a user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Skill Membership","name":"Creating a new Skill Membership","isWebhook":false,"pointer":"/paths/~1skill_memberships/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Skill Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a skill to a user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 200 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"skill_memberships\": [\n {\n \"skill_id\": 123,\n \"user_id\": 111\n },\n {\n \"skill_id\": 456,\n \"user_id\": 222\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"skill_memberships\": [\n {\n \"skill_id\": 123,\n \"user_id\": 111\n },\n {\n \"skill_id\": 456,\n \"user_id\": 222\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Skill Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skill_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - References the user who has created the skill association.\n- `skill` (Skill) - References the skill assigned to the object.\n- `user` (User) - References the user who has been assigned the skill."}],"pointer":"/paths/~1skill_memberships/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_354"}},"schemaId":"schema_354","pointer":"/paths/~1skill_memberships/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/skill_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_354"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/skill_memberships","href":"skill-memberships/create skill membership","openApiOperationId":"Create Skill Membership","summary":"Creating a new Skill Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_354","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_354"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Skill Membership has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353"}},"schemaId":"schema_353"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1skill_memberships/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_353","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/skill_memberships"},{"label":"Fetching a single Skill Membership","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/skill-memberships/get skill membership","routeSlug":"/kantata/specification/skill-memberships/get skill membership","metadata":{"seo":{"title":"Fetching a single Skill Membership","description":"Returns a skill membership."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Skill Membership","name":"Fetching a single Skill Membership","isWebhook":false,"pointer":"/paths/~1skill_memberships~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Skill Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a skill membership."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Skill Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skill_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1skill_memberships~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - References the user who has created the skill association.\n- `skill` (Skill) - References the skill assigned to the object.\n- `user` (User) - References the user who has been assigned the skill."}],"pointer":"/paths/~1skill_memberships~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/skill_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/skill_memberships/{id}","href":"skill-memberships/get skill membership","openApiOperationId":"Get Skill Membership","summary":"Fetching a single Skill Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Skill Membership has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353"}},"schemaId":"schema_353"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1skill_memberships~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_353","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/skill_memberships/{id}"},{"label":"Updating an existing Skill Membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/skill-memberships/update skill membership","routeSlug":"/kantata/specification/skill-memberships/update skill membership","metadata":{"seo":{"title":"Updating an existing Skill Membership","description":"This endpoint returns structured Skill Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the skill_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Skill Membership","name":"Updating an existing Skill Membership","isWebhook":false,"pointer":"/paths/~1skill_memberships~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Skill Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Skill Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skill_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1skill_memberships~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - References the user who has created the skill association.\n- `skill` (Skill) - References the skill assigned to the object.\n- `user` (User) - References the user who has been assigned the skill."}],"pointer":"/paths/~1skill_memberships~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_355"}},"schemaId":"schema_355","pointer":"/paths/~1skill_memberships~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/skill_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_355"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/skill_memberships/{id}","href":"skill-memberships/update skill membership","openApiOperationId":"Update Skill Membership","summary":"Updating an existing Skill Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_355","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_355"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Skill Membership has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353"}},"schemaId":"schema_353"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1skill_memberships~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_353","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/skill_memberships/{id}"},{"label":"Deleting an existing Skill Membership","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/skill-memberships/delete skill membership","routeSlug":"/kantata/specification/skill-memberships/delete skill membership","metadata":{"seo":{"title":"Deleting an existing Skill Membership","description":"Removes a skill from a user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Skill Membership","name":"Deleting an existing Skill Membership","isWebhook":false,"pointer":"/paths/~1skill_memberships~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Skill Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes a skill from a user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1skill_memberships~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/skill_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/skill_memberships/{id}","href":"skill-memberships/delete skill membership","openApiOperationId":"Delete Skill Membership","summary":"Deleting an existing Skill Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Skill Membership has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1skill_memberships~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/skill_memberships/{id}"}],"content":{"contentType":"group","meta":{"name":"Skill Memberships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Skill Memberships","showPageActions":true},{"nodeType":"markdoc","content":"Skill Memberships represent skills that has been assigned to a specified user."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/skill_memberships","summary":"Fetching a list of Skill Memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/skill-memberships/get skill memberships","deprecated":false},{"title":"/skill_memberships","summary":"Creating a new Skill Membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/skill-memberships/create skill membership","deprecated":false},{"title":"/skill_memberships/{id}","summary":"Fetching a single Skill Membership","prefix":{"name":"get","color":"get"},"badges":[],"link":"/skill-memberships/get skill membership","deprecated":false},{"title":"/skill_memberships/{id}","summary":"Updating an existing Skill Membership","prefix":{"name":"put","color":"put"},"badges":[],"link":"/skill-memberships/update skill membership","deprecated":false},{"title":"/skill_memberships/{id}","summary":"Deleting an existing Skill Membership","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/skill-memberships/delete skill membership","deprecated":false}]}]}]}]}},{"type":"group","label":"Skills","link":"/kantata/specification/skills","routeSlug":"/kantata/specification/skills","items":[{"label":"Fetching a list of Skills","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/skills/get skills","routeSlug":"/kantata/specification/skills/get skills","metadata":{"seo":{"title":"Fetching a list of Skills","description":"The Skills endpoint provides a list of every Skill that belongs to the Account of the User making the request.The response will contain an array of Skill objects, sorted alphabetically by the name attribute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Skills","name":"Fetching a list of Skills","isWebhook":false,"pointer":"/paths/~1skills/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Skills","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Skills endpoint provides a list of every Skill that belongs to the Account of the User making the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain an array of Skill objects, sorted alphabetically by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You cannot create more than 5000 skills per account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Skill objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"except","in":"query","schemaId":"schema_304","description":"Includes the skills that are not in the passed in set of skill ids. For example, '10,15'."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"for_users","in":"query","schemaId":"schema_304","description":"Includes skills that are not already associated with these users. For example, '10,15'."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `skill_category` (SkillCategory) - The Skill Category under which the Skill is grouped."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Includes skills with a name that matches the search string."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_343","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `alphabetical:asc` and `alphabetical:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"skill_category_ids","in":"query","schemaId":"schema_304","description":"Includes skills that are associated with these skill categories. For example, '2,25'."},{"name":"unassigned_skills_for_estimate_scenario_resource","in":"query","schemaId":"schema_313","description":"Includes the skills that an estimate scenario resource has not been assigned."},{"name":"unassigned_skills_for_project_template_assignment","in":"query","schemaId":"schema_313","description":"Includes the skills that a project template assignment has not been assigned."},{"name":"unassigned_skills_for_user","in":"query","schemaId":"schema_313","description":"Includes the skills that a user has not been assigned."},{"name":"unassigned_skills_for_workspace_resource","in":"query","schemaId":"schema_313","description":"Includes the skills that a workspace resource has not been assigned."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1skills/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/skills","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"except","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"for_users","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_343"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"skill_category_ids","in":"query","schemaId":"schema_304"},{"name":"unassigned_skills_for_estimate_scenario_resource","in":"query","schemaId":"schema_313"},{"name":"unassigned_skills_for_project_template_assignment","in":"query","schemaId":"schema_313"},{"name":"unassigned_skills_for_user","in":"query","schemaId":"schema_313"},{"name":"unassigned_skills_for_workspace_resource","in":"query","schemaId":"schema_313"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/skills","href":"skills/get skills","openApiOperationId":"Get Skills","summary":"Fetching a list of Skills"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Skills have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1skills/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/skills"},{"label":"Creating a new Skill","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/skills/create skill","routeSlug":"/kantata/specification/skills/create skill","metadata":{"seo":{"title":"Creating a new Skill","description":"Adds a new skill to the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Skill","name":"Creating a new Skill","isWebhook":false,"pointer":"/paths/~1skills/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Skill","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a new skill to the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You cannot create more than 5000 skills per account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 200 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" {\n \"skills\": [\n {\n \"name\": \"Skill\",\n \"skill_category_id\": 123\n },\n {\n \"name\": \"Skill 2\",\n \"skill_category_id\": 456\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" {\n \"skills\": [\n {\n \"name\": \"Skill\",\n \"skill_category_id\": 123\n },\n {\n \"name\": \"Skill 2\",\n \"skill_category_id\": 456\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Skill objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `skill_category` (SkillCategory) - The Skill Category under which the Skill is grouped."}],"pointer":"/paths/~1skills/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_357"}},"schemaId":"schema_357","pointer":"/paths/~1skills/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/skills","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_357"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/skills","href":"skills/create skill","openApiOperationId":"Create Skill","summary":"Creating a new Skill"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_357","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_357"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Skill has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1skills/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/skills"},{"label":"Fetching a single Skill","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/skills/get skill","routeSlug":"/kantata/specification/skills/get skill","metadata":{"seo":{"title":"Fetching a single Skill","description":"This endpoint returns structured Skill objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the skills top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Skill","name":"Fetching a single Skill","isWebhook":false,"pointer":"/paths/~1skills~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Skill","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Skill objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1skills~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `skill_category` (SkillCategory) - The Skill Category under which the Skill is grouped."}],"pointer":"/paths/~1skills~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/skills/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/skills/{id}","href":"skills/get skill","openApiOperationId":"Get Skill","summary":"Fetching a single Skill"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Skill has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1skills~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/skills/{id}"},{"label":"Updating an existing Skill","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/skills/update skill","routeSlug":"/kantata/specification/skills/update skill","metadata":{"seo":{"title":"Updating an existing Skill","description":"This endpoint returns structured Skill objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the skills top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Skill","name":"Updating an existing Skill","isWebhook":false,"pointer":"/paths/~1skills~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Skill","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Skill objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1skills~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `skill_category` (SkillCategory) - The Skill Category under which the Skill is grouped."}],"pointer":"/paths/~1skills~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_358"}},"schemaId":"schema_358","pointer":"/paths/~1skills~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/skills/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_358"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/skills/{id}","href":"skills/update skill","openApiOperationId":"Update Skill","summary":"Updating an existing Skill"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_358","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_358"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Skill has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1skills~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/skills/{id}"},{"label":"Deleting an existing Skill","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/skills/delete skill","routeSlug":"/kantata/specification/skills/delete skill","metadata":{"seo":{"title":"Deleting an existing Skill","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Skill","name":"Deleting an existing Skill","isWebhook":false,"pointer":"/paths/~1skills~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Skill","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1skills~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/skills/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/skills/{id}","href":"skills/delete skill","openApiOperationId":"Delete Skill","summary":"Deleting an existing Skill"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Skill has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1skills~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/skills/{id}"}],"content":{"contentType":"group","meta":{"name":"Skills"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Skills","showPageActions":true},{"nodeType":"markdoc","content":"Skills are used in Kantata OX to describe capabilities of users for the purposes of resource planning.\nThey can be associated with a user through a Skill Membership.\nA user can be associated with up to 200 skills.\nThis model includes categories such as 'Skill', 'Language', 'Certification' and 'Other'."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/skills","summary":"Fetching a list of Skills","prefix":{"name":"get","color":"get"},"badges":[],"link":"/skills/get skills","deprecated":false},{"title":"/skills","summary":"Creating a new Skill","prefix":{"name":"post","color":"post"},"badges":[],"link":"/skills/create skill","deprecated":false},{"title":"/skills/{id}","summary":"Fetching a single Skill","prefix":{"name":"get","color":"get"},"badges":[],"link":"/skills/get skill","deprecated":false},{"title":"/skills/{id}","summary":"Updating an existing Skill","prefix":{"name":"put","color":"put"},"badges":[],"link":"/skills/update skill","deprecated":false},{"title":"/skills/{id}","summary":"Deleting an existing Skill","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/skills/delete skill","deprecated":false}]}]}]}]}},{"type":"group","label":"Task Status Sets","link":"/kantata/specification/task-status-sets","routeSlug":"/kantata/specification/task-status-sets","items":[{"label":"Fetching a list of Task Status Sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/task-status-sets/get task status sets","routeSlug":"/kantata/specification/task-status-sets/get task status sets","metadata":{"seo":{"title":"Fetching a list of Task Status Sets","description":"Gets a list of task status sets on the account. To include information in the response about the statuses within the sets, add ?include=custom_task_statuses to the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Task Status Sets","name":"Fetching a list of Task Status Sets","isWebhook":false,"pointer":"/paths/~1task_status_sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Task Status Sets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a list of task status sets on the account. To include information in the response about the statuses within the sets, add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include=custom_task_statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Task Status Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"task_status_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_task_statuses` (StatusSetOption) - Retrieves all of the statuses within this status set. The response will include `custom_task_status_ids`, which references the data in the `custom_task_statuses` top-level key."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1task_status_sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/task_status_sets","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/task_status_sets","href":"task-status-sets/get task status sets","openApiOperationId":"Get Task Status Sets","summary":"Fetching a list of Task Status Sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Task Status Sets have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1task_status_sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/task_status_sets"},{"label":"Creating a new Task Status Set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/task-status-sets/create task status set","routeSlug":"/kantata/specification/task-status-sets/create task status set","metadata":{"seo":{"title":"Creating a new Task Status Set","description":"Creates a task status set on the account that contains only the four default statuses (e.g. custom_task_statuses)—not started, started, needs info, and completed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Task Status Set","name":"Creating a new Task Status Set","isWebhook":false,"pointer":"/paths/~1task_status_sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Task Status Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a task status set on the account that contains only the four default statuses (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_task_statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")—"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not started"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"started"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"needs info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Task Status Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"task_status_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_task_statuses` (StatusSetOption) - Retrieves all of the statuses within this status set. The response will include `custom_task_status_ids`, which references the data in the `custom_task_statuses` top-level key."}],"pointer":"/paths/~1task_status_sets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_360"}},"schemaId":"schema_360","pointer":"/paths/~1task_status_sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/task_status_sets","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_360"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/task_status_sets","href":"task-status-sets/create task status set","openApiOperationId":"Create Task Status Set","summary":"Creating a new Task Status Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_360","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_360"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Task Status Set has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1task_status_sets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/task_status_sets"},{"label":"Fetching a single Task Status Set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/task-status-sets/get task status set","routeSlug":"/kantata/specification/task-status-sets/get task status set","metadata":{"seo":{"title":"Fetching a single Task Status Set","description":"Gets a task status set on the account. To include information in the response about the statuses within the set, add ?include=custom_task_statuses to the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Task Status Set","name":"Fetching a single Task Status Set","isWebhook":false,"pointer":"/paths/~1task_status_sets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Task Status Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a task status set on the account. To include information in the response about the statuses within the set, add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include=custom_task_statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Task Status Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"task_status_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1task_status_sets~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_task_statuses` (StatusSetOption) - Retrieves all of the statuses within this status set. The response will include `custom_task_status_ids`, which references the data in the `custom_task_statuses` top-level key."}],"pointer":"/paths/~1task_status_sets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/task_status_sets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/task_status_sets/{id}","href":"task-status-sets/get task status set","openApiOperationId":"Get Task Status Set","summary":"Fetching a single Task Status Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Task Status Set has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1task_status_sets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/task_status_sets/{id}"},{"label":"Updating an existing Task Status Set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/task-status-sets/update task status set","routeSlug":"/kantata/specification/task-status-sets/update task status set","metadata":{"seo":{"title":"Updating an existing Task Status Set","description":"Updates a task status set. Only the name can be updated with this endpoint. To update the statuses available in the set, use the Custom Task Statuses API instead. To change which set is the account default, use the Set Account Default Task Status Set endpoint instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Task Status Set","name":"Updating an existing Task Status Set","isWebhook":false,"pointer":"/paths/~1task_status_sets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Task Status Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a task status set. Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be updated with this endpoint. To update the statuses available in the set, use the Custom Task Statuses API instead. To change which set is the account default, use the Set Account Default Task Status Set endpoint instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Task Status Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"task_status_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1task_status_sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_task_statuses` (StatusSetOption) - Retrieves all of the statuses within this status set. The response will include `custom_task_status_ids`, which references the data in the `custom_task_statuses` top-level key."}],"pointer":"/paths/~1task_status_sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_360"}},"schemaId":"schema_360","pointer":"/paths/~1task_status_sets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/task_status_sets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_360"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/task_status_sets/{id}","href":"task-status-sets/update task status set","openApiOperationId":"Update Task Status Set","summary":"Updating an existing Task Status Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_360","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_360"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Task Status Set has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1task_status_sets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/task_status_sets/{id}"},{"label":"Deleting an existing Task Status Set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/task-status-sets/delete task status set","routeSlug":"/kantata/specification/task-status-sets/delete task status set","metadata":{"seo":{"title":"Deleting an existing Task Status Set","description":"Deletes a task status set and the statuses within the set. Only task status sets that are not in use can be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Task Status Set","name":"Deleting an existing Task Status Set","isWebhook":false,"pointer":"/paths/~1task_status_sets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Task Status Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a task status set and the statuses within the set. Only task status sets that are not in use can be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1task_status_sets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/task_status_sets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/task_status_sets/{id}","href":"task-status-sets/delete task status set","openApiOperationId":"Delete Task Status Set","summary":"Deleting an existing Task Status Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Task Status Set has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1task_status_sets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/task_status_sets/{id}"},{"label":"Update Account Default Task Status Set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/task-status-sets/update account default","routeSlug":"/kantata/specification/task-status-sets/update account default","metadata":{"seo":{"title":"Update Account Default Task Status Set","description":"Designates a task status set as the default set to be applied to new projects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Account Default","name":"Update Account Default Task Status Set","isWebhook":false,"pointer":"/paths/~1task_status_sets~1{id}~1update_account_default/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Account Default Task Status Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Designates a task status set as the default set to be applied to new projects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Task Status Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"task_status_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1task_status_sets~1{id}~1update_account_default/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_task_statuses` (StatusSetOption) - Retrieves all of the statuses within this status set. The response will include `custom_task_status_ids`, which references the data in the `custom_task_statuses` top-level key."}],"pointer":"/paths/~1task_status_sets~1{id}~1update_account_default/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/task_status_sets/{id}/update_account_default","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/task_status_sets/{id}/update_account_default","href":"task-status-sets/update account default","openApiOperationId":"Update Account Default","summary":"Update Account Default Task Status Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Task Status Set has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1task_status_sets~1{id}~1update_account_default/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/task_status_sets/{id}/update_account_default"}],"content":{"contentType":"group","meta":{"name":"Task Status Sets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Task Status Sets","showPageActions":true},{"nodeType":"markdoc","content":"Task Status Sets allow you to create custom statuses for tasks (stories) that can then be applied to projects."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/task_status_sets","summary":"Fetching a list of Task Status Sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/task-status-sets/get task status sets","deprecated":false},{"title":"/task_status_sets","summary":"Creating a new Task Status Set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/task-status-sets/create task status set","deprecated":false},{"title":"/task_status_sets/{id}","summary":"Fetching a single Task Status Set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/task-status-sets/get task status set","deprecated":false},{"title":"/task_status_sets/{id}","summary":"Updating an existing Task Status Set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/task-status-sets/update task status set","deprecated":false},{"title":"/task_status_sets/{id}","summary":"Deleting an existing Task Status Set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/task-status-sets/delete task status set","deprecated":false},{"title":"/task_status_sets/{id}/update_account_default","summary":"Update Account Default Task Status Set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/task-status-sets/update account default","deprecated":false}]}]}]}]}},{"type":"group","label":"Task Statuses","link":"/kantata/specification/task-statuses","routeSlug":"/kantata/specification/task-statuses","items":[{"label":"Fetching a list of Custom Task Statuses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/task-statuses/get custom task statuses","routeSlug":"/kantata/specification/task-statuses/get custom task statuses","metadata":{"seo":{"title":"Fetching a list of Custom Task Statuses","description":"This endpoint returns structured Custom Task Status objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the custom_task_statuses top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Custom Task Statuses","name":"Fetching a list of Custom Task Statuses","isWebhook":false,"pointer":"/paths/~1custom_task_statuses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Custom Task Statuses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Task Status objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_task_statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `task_status_set` (StatusSet) - Retrieves the task status set the custom status is in. The response will include `task_status_set_id`, which references the data in the `task_status_sets` top-level key."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1custom_task_statuses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom_task_statuses","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_task_statuses","href":"task-statuses/get custom task statuses","openApiOperationId":"Get Custom Task Statuses","summary":"Fetching a list of Custom Task Statuses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Custom Task Statuses have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_task_statuses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_task_statuses"},{"label":"Creating a new Custom Task Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/task-statuses/create custom task status","routeSlug":"/kantata/specification/task-statuses/create custom task status","metadata":{"seo":{"title":"Creating a new Custom Task Status","description":"Adds a new custom status to a task status set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Custom Task Status","name":"Creating a new Custom Task Status","isWebhook":false,"pointer":"/paths/~1custom_task_statuses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Custom Task Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a new custom status to a task status set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Task Status objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_task_statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `task_status_set` (StatusSet) - Retrieves the task status set the custom status is in. The response will include `task_status_set_id`, which references the data in the `task_status_sets` top-level key."}],"pointer":"/paths/~1custom_task_statuses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_361"}},"schemaId":"schema_361","pointer":"/paths/~1custom_task_statuses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/custom_task_statuses","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_361"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_task_statuses","href":"task-statuses/create custom task status","openApiOperationId":"Create Custom Task Status","summary":"Creating a new Custom Task Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_361","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_361"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Custom Task Status has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_task_statuses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_task_statuses"},{"label":"Fetching a single Custom Task Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/task-statuses/get custom task status","routeSlug":"/kantata/specification/task-statuses/get custom task status","metadata":{"seo":{"title":"Fetching a single Custom Task Status","description":"This endpoint returns structured Custom Task Status objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the custom_task_statuses top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Custom Task Status","name":"Fetching a single Custom Task Status","isWebhook":false,"pointer":"/paths/~1custom_task_statuses~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Custom Task Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Task Status objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_task_statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1custom_task_statuses~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `task_status_set` (StatusSet) - Retrieves the task status set the custom status is in. The response will include `task_status_set_id`, which references the data in the `task_status_sets` top-level key."}],"pointer":"/paths/~1custom_task_statuses~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom_task_statuses/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_task_statuses/{id}","href":"task-statuses/get custom task status","openApiOperationId":"Get Custom Task Status","summary":"Fetching a single Custom Task Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Custom Task Status has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_task_statuses~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_task_statuses/{id}"},{"label":"Updating an existing Custom Task Status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/task-statuses/update custom task status","routeSlug":"/kantata/specification/task-statuses/update custom task status","metadata":{"seo":{"title":"Updating an existing Custom Task Status","description":"Updates a custom task status. The name and position in the task status set can be updated. The status cannot be moved to a different status set and the category cannot be changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Custom Task Status","name":"Updating an existing Custom Task Status","isWebhook":false,"pointer":"/paths/~1custom_task_statuses~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Custom Task Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a custom task status. The name and position in the task status set can be updated. The status cannot be moved to a different status set and the category cannot be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Task Status objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_task_statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1custom_task_statuses~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `task_status_set` (StatusSet) - Retrieves the task status set the custom status is in. The response will include `task_status_set_id`, which references the data in the `task_status_sets` top-level key."}],"pointer":"/paths/~1custom_task_statuses~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","pointer":"/paths/~1custom_task_statuses~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/custom_task_statuses/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_362"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_task_statuses/{id}","href":"task-statuses/update custom task status","openApiOperationId":"Update Custom Task Status","summary":"Updating an existing Custom Task Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_362"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Custom Task Status has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_task_statuses~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_task_statuses/{id}"},{"label":"Deleting an existing Custom Task Status","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/task-statuses/delete custom task status","routeSlug":"/kantata/specification/task-statuses/delete custom task status","metadata":{"seo":{"title":"Deleting an existing Custom Task Status","description":"Deletes a custom task status within a task status set. If assigned to a task (story), the task’s status will default to the status type (category)—not started, started, needs info, or completed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Custom Task Status","name":"Deleting an existing Custom Task Status","isWebhook":false,"pointer":"/paths/~1custom_task_statuses~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Custom Task Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a custom task status within a task status set. If assigned to a task (story), the task’s "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will default to the status type (category)—"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not started"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"started"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"needs info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will delete the task status from this set. If this status is currently being used by a task in a project, the status will reset to its default status type: Not Started, Started, Needs Info, or Completed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1custom_task_statuses~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/custom_task_statuses/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/custom_task_statuses/{id}","href":"task-statuses/delete custom task status","openApiOperationId":"Delete Custom Task Status","summary":"Deleting an existing Custom Task Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Custom Task Status has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_task_statuses~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_task_statuses/{id}"}],"content":{"contentType":"group","meta":{"name":"Task Statuses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Task Statuses","showPageActions":true},{"nodeType":"markdoc","content":"Custom task statuses can be created to be used on tasks (stories). Custom task statuses are associated to task status sets, which can be applied to projects (workspaces)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custom_task_statuses","summary":"Fetching a list of Custom Task Statuses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/task-statuses/get custom task statuses","deprecated":false},{"title":"/custom_task_statuses","summary":"Creating a new Custom Task Status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/task-statuses/create custom task status","deprecated":false},{"title":"/custom_task_statuses/{id}","summary":"Fetching a single Custom Task Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/task-statuses/get custom task status","deprecated":false},{"title":"/custom_task_statuses/{id}","summary":"Updating an existing Custom Task Status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/task-statuses/update custom task status","deprecated":false},{"title":"/custom_task_statuses/{id}","summary":"Deleting an existing Custom Task Status","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/task-statuses/delete custom task status","deprecated":false}]}]}]}]}},{"type":"group","label":"User Group Memberships","link":"/kantata/specification/user-group-memberships","routeSlug":"/kantata/specification/user-group-memberships","items":[{"label":"Fetching a list of User Group Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/user-group-memberships/get user group memberships","routeSlug":"/kantata/specification/user-group-memberships/get user group memberships","metadata":{"seo":{"title":"Fetching a list of User Group Memberships","description":"This endpoint returns structured User Group Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the user_group_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get User Group Memberships","name":"Fetching a list of User Group Memberships","isWebhook":false,"pointer":"/paths/~1user_group_memberships/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of User Group Memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User Group Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_group_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"group_ids","in":"query","schemaId":"schema_304","description":"Return only memberships associated with the specified Workspace Group IDs. Provide a comma-separated list of Workspace Group IDs or an array of IDs. For example, `10,20`."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - Retrieves the associated user. The response will include `user_id`, which references the data in the `users` top-level key.\n- `workspace_group` (WorkspaceGroup) - Retrieves the associated Workspace Group. The response will include `workspace_group_id`, which references the data in the `workspace_groups` top-level key."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"user_ids","in":"query","schemaId":"schema_304","description":"Return only memberships associated with the specified user IDs. Provide a comma-separated list of user IDs or an array of IDs. For example, `10,20`."}],"pointer":"/paths/~1user_group_memberships/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user_group_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"group_ids","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"user_ids","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/user_group_memberships","href":"user-group-memberships/get user group memberships","openApiOperationId":"Get User Group Memberships","summary":"Fetching a list of User Group Memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of User Group Memberships have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1user_group_memberships/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/user_group_memberships"},{"label":"Creating a new User Group Membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/user-group-memberships/create user group memberships","routeSlug":"/kantata/specification/user-group-memberships/create user group memberships","metadata":{"seo":{"title":"Creating a new User Group Membership","description":"Adds a user to a Workspace Group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create User Group Memberships","name":"Creating a new User Group Membership","isWebhook":false,"pointer":"/paths/~1user_group_memberships/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new User Group Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a user to a Workspace Group."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"user_group_memberships\": [\n {\n \"user_id\": 123,\n \"workspace_group_id\": 111\n },\n {\n \"user_id\": 456,\n \"workspace_group_id\": 111\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"user_group_memberships\": [\n {\n \"user_id\": 123,\n \"workspace_group_id\": 111\n },\n {\n \"user_id\": 456,\n \"workspace_group_id\": 111\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User Group Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_group_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - Retrieves the associated user. The response will include `user_id`, which references the data in the `users` top-level key.\n- `workspace_group` (WorkspaceGroup) - Retrieves the associated Workspace Group. The response will include `workspace_group_id`, which references the data in the `workspace_groups` top-level key."}],"pointer":"/paths/~1user_group_memberships/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_364"}},"schemaId":"schema_364","pointer":"/paths/~1user_group_memberships/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/user_group_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_364"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/user_group_memberships","href":"user-group-memberships/create user group memberships","openApiOperationId":"Create User Group Memberships","summary":"Creating a new User Group Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_364","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_364"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User Group Membership has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1user_group_memberships/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/user_group_memberships"},{"label":"Deleting an existing User Group Membership","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/user-group-memberships/delete user group membership","routeSlug":"/kantata/specification/user-group-memberships/delete user group membership","metadata":{"seo":{"title":"Deleting an existing User Group Membership","description":"Removes a user from a Workspace Group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete User Group Membership","name":"Deleting an existing User Group Membership","isWebhook":false,"pointer":"/paths/~1user_group_memberships~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing User Group Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes a user from a Workspace Group."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1user_group_memberships~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/user_group_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/user_group_memberships/{id}","href":"user-group-memberships/delete user group membership","openApiOperationId":"Delete User Group Membership","summary":"Deleting an existing User Group Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"User Group Membership has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1user_group_memberships~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/user_group_memberships/{id}"}],"content":{"contentType":"group","meta":{"name":"User Group Memberships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Group Memberships","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A User Group Membership represents the connection of a user to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Workspace-Groups"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workspace Group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must be an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/203041364"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Administrator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use these endpoints."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/user_group_memberships","summary":"Fetching a list of User Group Memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-group-memberships/get user group memberships","deprecated":false},{"title":"/user_group_memberships","summary":"Creating a new User Group Membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-group-memberships/create user group memberships","deprecated":false},{"title":"/user_group_memberships/{id}","summary":"Deleting an existing User Group Membership","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user-group-memberships/delete user group membership","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/kantata/specification/users","routeSlug":"/kantata/specification/users","items":[{"label":"Fetching visible users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/get users","routeSlug":"/kantata/specification/users/get users","metadata":{"seo":{"title":"Fetching visible users","description":"This endpoint allows you to access all visible users based on the permission level of the requester."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Users","name":"Fetching visible users","isWebhook":false,"pointer":"/paths/~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching visible users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to access all visible users based on the permission level of the requester."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This endpoint relies on project participation and will not return a member of your account"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"who is not in a project. To see all users on the account, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"on_my_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the requester is an Account Administrator, the request will return all users who are participating in a project on the requester's account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition, it will return users not on the requester's account if they are participating in any project with an account member (either on the requester's account or their own account)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the requester is not an Account Administrator, the request will only return users who are participating in a project with the requester."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account_id","in":"query","schemaId":"schema_313","description":"Only includes users on the specified account. This filter is not available in conjunction with the `on_my_account` option."},{"name":"account_role_ids","in":"query","schemaId":"schema_304","description":"Only includes users with a specified role ID. (Format: 'role_id,role_id')."},{"name":"all_contacts","in":"query","schemaId":"schema_305","description":"Returns all users in the requester's contact list."},{"name":"assignable_to_resource","in":"query","schemaId":"schema_313","description":"Only includes users who can be assigned to a project resource with a specified ID."},{"name":"belonging_to_orgs","in":"query","schemaId":"schema_304","description":"Only includes users that belong to the specified geographies or departments (Format: 'geo_id,geo_id;dept_id,dept_id')."},{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field choice value, represented as a string with the custom field ID, followed by a\ncolon, and then comma-separated custom field choice value IDs. The custom field choice value can also be\nthe word `blank`. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\n\nThe following formats are supported:\n\n- `custom_field_ID:choice_value_ID`\n- `custom_field_ID:choice_value_1_ID,choice_value_2_ID`\n- `custom_field_ID:blank`\n- `(custom_field_1_ID:choice_value_1_ID,choice_value_2_ID):(custom_field_2_ID:choice_value_3_ID)`."},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field currency value, represented as a string with the custom field ID, followed by a\ncolon, and then the currency value. Optionally, the currency [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473) can be supplied as well, separated\nfrom the currency value by another colon. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200.2:USD):(2:100)`."},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field date value, represented as a string with the custom field ID, followed by a\ncolon, the starting date, another colon, and then the ending date. You can provide both a starting date\nand ending date, or provide just one. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:2014-12-05:2014-12-25):(2:2014-12-05)`."},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field number value, represented as a string with the custom field ID, followed by a\ncolon, and then the number value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200):(2:101)`."},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field text value, represented as a string with the custom field ID, followed by a\ncolon, and then the text value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:something):(2:else)`\n- `(1:something):(1:else)` (multiple values for the same field, returns objects matching any value)\n- `1` (bare field ID with no value, returns all objects that have any value for that field)."},{"name":"by_email_address","in":"query","schemaId":"schema_304","description":"Only includes users whose email address exactly matches the specified address."},{"name":"by_email_addresses","in":"query","schemaId":"schema_304","description":"Return only users whose email addresses exactly match the specified email addresses.\nYou can provide a list of comma-separated email addresses as a query parameter in the request URL or\nprovide an array of email addresses in the request body. You can specify up to 200 email addresses."},{"name":"by_full_name","in":"query","schemaId":"schema_304","description":"Only includes users with all or part of the specified full name."},{"name":"by_full_name_or_account_role","in":"query","schemaId":"schema_304","description":"Only includes users with a matching full_name or default_role specified a search term."},{"name":"can_be_approver_in_workspace","in":"query","schemaId":"schema_313","description":"Only includes users that are providers and have financial access in a project with a specified ID."},{"name":"can_view_reports","in":"query","schemaId":"schema_305","description":"Only include users who have account level permission of reports viewer or above."},{"name":"clients_only","in":"query","schemaId":"schema_305","description":"Only includes users that are in at least one project as a client."},{"name":"consultants_only","in":"query","schemaId":"schema_305","description":"Only includes users that are in at least one project as a provider."},{"name":"contacts_on_different_account","in":"query","schemaId":"schema_305","description":"Returns all the users that are in the requester's contact list, but on seperate accounts."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304","description":"Filter by the presence of a custom field value for the specified comma-separated custom field ID(s)."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `manager` (User) - Retrieves the user's manager. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `role` (Role) - Retrieves the user's account role. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user's proficiency level (for skills which can be assigned proficiency levels).\n- `skills` (Skill) - Retrieves the user's skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.\n- `work_samples` (WorkSample) - Retrieves the user's portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key."},{"name":"is_project_lead","in":"query","schemaId":"schema_305","description":"Only include users who have account level permission of project lead or above."},{"name":"managers","in":"query","schemaId":"schema_351","description":"Only include users who are managers."},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"not_assigned_to","in":"query","schemaId":"schema_313","description":"Only includes users who are not assigned to a task with specified ID."},{"name":"not_following","in":"query","schemaId":"schema_313","description":"Only includes users who are not following a task with the specified ID."},{"name":"not_on_calendars","in":"query","schemaId":"schema_304","description":"Only includes users who are not added to the specified holiday calendars (Format: 'calendar_id,calendar_id,calendar_id'."},{"name":"not_participant_in","in":"query","schemaId":"schema_313","description":"Only includes users not participating in a project with a specified ID."},{"name":"on_my_account","in":"query","schemaId":"schema_305","description":"Returns all users on the requester's account."},{"name":"on_my_account_or_participant_in_workspace","in":"query","schemaId":"schema_313","description":"Returns all the users that are on the account, as well as all users participating in the provided workspace ID."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"only_possible_managees","in":"query","schemaId":"schema_305","description":"Only includes possible managees on the account."},{"name":"only_possible_managers","in":"query","schemaId":"schema_305","description":"Only includes possible managers on the account."},{"name":"optional_fields","in":"query","schemaId":"schema_365","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_343","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `alphabetical:asc` and `alphabetical:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"participant_in","in":"query","schemaId":"schema_313","description":"Only includes users participating in a project with a specified ID."},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"potential_followers_for_story","in":"query","schemaId":"schema_313","description":"Only includes users who are able to follow a task with the specified ID."},{"name":"provider_leads_on_account_projects","in":"query","schemaId":"schema_305","description":"Only includes users who are providers and leads in projects on the requester's account."},{"name":"search","in":"query","schemaId":"schema_304"},{"name":"show_disabled","in":"query","schemaId":"schema_351","description":"Includes users with an inactive account membership and users who have been disabled by the Kantata team."},{"name":"show_users_in_insights_groups","in":"query","schemaId":"schema_305","description":"Only includes users who have access to insights."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"with_created_estimates","in":"query","schemaId":"schema_351","description":"Only include users who have created an estimate."},{"name":"with_organizations","in":"query","schemaId":"schema_305","description":"Only includes users that have an organization (true) or only includes users that do not have an organization (false)."},{"name":"with_skills","in":"query","schemaId":"schema_304","description":"Only includes users with a set of skills at the specified levels (Format: '{'skill_id':[level,level],'skill_id':[level],'operation':''}')."},{"name":"with_users","in":"query","schemaId":"schema_352","description":"Include only users for the provided IDs (Format: 'id,id,id')."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"without_skills","in":"query","schemaId":"schema_304","description":"Only includes users without the specified set of skills (Format: 'id,id,id')."},{"name":"without_timesheet_submission","in":"query","schemaId":"schema_304","description":"Only include users who have not submitted a timesheet in a project between the specified start and end dates. (Format: 'workspace_id:start_date:end_date')."},{"name":"without_users","in":"query","schemaId":"schema_352","description":"Exclude users for the provided IDs (Format: 'id,id,id')."},{"name":"write_access_in","in":"query","schemaId":"schema_313","description":"Only includes users who are participating in a project with a specified ID, and are not read-only in the project."}],"pointer":"/paths/~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"account_id","in":"query","schemaId":"schema_313"},{"name":"account_role_ids","in":"query","schemaId":"schema_304"},{"name":"all_contacts","in":"query","required":false,"schemaId":"schema_305"},{"name":"assignable_to_resource","in":"query","schemaId":"schema_313"},{"name":"belonging_to_orgs","in":"query","schemaId":"schema_304"},{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304"},{"name":"by_email_address","in":"query","schemaId":"schema_304"},{"name":"by_email_addresses","in":"query","schemaId":"schema_304"},{"name":"by_full_name","in":"query","schemaId":"schema_304"},{"name":"by_full_name_or_account_role","in":"query","schemaId":"schema_304"},{"name":"can_be_approver_in_workspace","in":"query","schemaId":"schema_313"},{"name":"can_view_reports","in":"query","schemaId":"schema_305"},{"name":"clients_only","in":"query","schemaId":"schema_305"},{"name":"consultants_only","in":"query","schemaId":"schema_305"},{"name":"contacts_on_different_account","in":"query","required":false,"schemaId":"schema_305"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"is_project_lead","in":"query","schemaId":"schema_305"},{"name":"managers","in":"query","schemaId":"schema_351"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"not_assigned_to","in":"query","schemaId":"schema_313"},{"name":"not_following","in":"query","schemaId":"schema_313"},{"name":"not_on_calendars","in":"query","schemaId":"schema_304"},{"name":"not_participant_in","in":"query","schemaId":"schema_313"},{"name":"on_my_account","in":"query","required":false,"schemaId":"schema_305"},{"name":"on_my_account_or_participant_in_workspace","in":"query","required":false,"schemaId":"schema_313"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"only_possible_managees","in":"query","schemaId":"schema_305"},{"name":"only_possible_managers","in":"query","schemaId":"schema_305"},{"name":"optional_fields","in":"query","schemaId":"schema_365","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_343"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"participant_in","in":"query","schemaId":"schema_313"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"potential_followers_for_story","in":"query","schemaId":"schema_313"},{"name":"provider_leads_on_account_projects","in":"query","schemaId":"schema_305"},{"name":"search","in":"query","schemaId":"schema_304"},{"name":"show_disabled","in":"query","schemaId":"schema_351"},{"name":"show_users_in_insights_groups","in":"query","schemaId":"schema_305"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"with_created_estimates","in":"query","schemaId":"schema_351"},{"name":"with_organizations","in":"query","schemaId":"schema_305"},{"name":"with_skills","in":"query","schemaId":"schema_304"},{"name":"with_users","in":"query","schemaId":"schema_352","style":"form","explode":false},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"without_skills","in":"query","schemaId":"schema_304"},{"name":"without_timesheet_submission","in":"query","schemaId":"schema_304"},{"name":"without_users","in":"query","schemaId":"schema_352","style":"form","explode":false},{"name":"write_access_in","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/users","href":"users/get users","openApiOperationId":"Get Users","summary":"Fetching visible users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Users have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users"},{"label":"Fetch your own data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/get my user data","routeSlug":"/kantata/specification/users/get my user data","metadata":{"seo":{"title":"Fetch your own data","description":"This endpoint allows you to fetch your own data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get My User Data","name":"Fetch your own data","isWebhook":false,"pointer":"/paths/~1users~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch your own data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to fetch your own data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `manager` (User) - Retrieves the user's manager. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `role` (Role) - Retrieves the user's account role. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user's proficiency level (for skills which can be assigned proficiency levels).\n- `skills` (Skill) - Retrieves the user's skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.\n- `work_samples` (WorkSample) - Retrieves the user's portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_365","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1users~1me/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/me","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_365","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/users/me","href":"users/get my user data","openApiOperationId":"Get My User Data","summary":"Fetch your own data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Users have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users/me"},{"label":"Fetching a single User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/get user","routeSlug":"/kantata/specification/users/get user","metadata":{"seo":{"title":"Fetching a single User","description":"This endpoint returns structured User objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the users top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get User","name":"Fetching a single User","isWebhook":false,"pointer":"/paths/~1users~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1users~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `manager` (User) - Retrieves the user's manager. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `role` (Role) - Retrieves the user's account role. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user's proficiency level (for skills which can be assigned proficiency levels).\n- `skills` (Skill) - Retrieves the user's skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.\n- `work_samples` (WorkSample) - Retrieves the user's portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_365","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1users~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_365","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/users/{id}","href":"users/get user","openApiOperationId":"Get User","summary":"Fetching a single User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The User has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users/{id}"},{"label":"Updating an existing User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/update user","routeSlug":"/kantata/specification/users/update user","metadata":{"seo":{"title":"Updating an existing User","description":"This endpoint returns structured User objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the users top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update User","name":"Updating an existing User","isWebhook":false,"pointer":"/paths/~1users~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1users~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `manager` (User) - Retrieves the user's manager. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `role` (Role) - Retrieves the user's account role. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user's proficiency level (for skills which can be assigned proficiency levels).\n- `skills` (Skill) - Retrieves the user's skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.\n- `work_samples` (WorkSample) - Retrieves the user's portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_365","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1users~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_367"}},"schemaId":"schema_367","pointer":"/paths/~1users~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_365","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_367"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/users/{id}","href":"users/update user","openApiOperationId":"Update User","summary":"Updating an existing User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_367","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_367"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users/{id}"},{"label":"Fetch My Work Capacity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/get my work capacity","routeSlug":"/kantata/specification/users/get my work capacity","metadata":{"seo":{"title":"Fetch My Work Capacity","description":"This endpoint returns a summary of a user's work capacity for a provided range of dates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get My Work Capacity","name":"Fetch My Work Capacity","isWebhook":false,"pointer":"/paths/~1users~1{id}~1capacity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch My Work Capacity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns a summary of a user's work capacity for a provided range of dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1users~1{id}~1capacity/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"end_date","in":"query","schemaId":"schema_368","description":"The end date for calculating my work capacity in YYYY-MM-DD format (e.g. 2016-01-01). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.","required":true},{"name":"start_date","in":"query","schemaId":"schema_368","description":"The start date for calculating my work capacity in YYYY-MM-DD format (e.g. 2015-12-16). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.","required":true},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `manager` (User) - Retrieves the user's manager. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `role` (Role) - Retrieves the user's account role. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user's proficiency level (for skills which can be assigned proficiency levels).\n- `skills` (Skill) - Retrieves the user's skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.\n- `work_samples` (WorkSample) - Retrieves the user's portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_365","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1users~1{id}~1capacity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{id}/capacity","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"end_date","in":"query","required":true,"schemaId":"schema_368"},{"name":"start_date","in":"query","required":true,"schemaId":"schema_368"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_365","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/users/{id}/capacity","href":"users/get my work capacity","openApiOperationId":"Get My Work Capacity","summary":"Fetch My Work Capacity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Users have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users~1{id}~1capacity/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users/{id}/capacity"},{"label":"Reset Profile Photo","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/reset user profile photo","routeSlug":"/kantata/specification/users/reset user profile photo","metadata":{"seo":{"title":"Reset Profile Photo","description":"Delete the profile photo for the specified user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Reset User Profile Photo","name":"Reset Profile Photo","isWebhook":false,"pointer":"/paths/~1users~1{id}~1profile_photo/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset Profile Photo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete the profile photo for the specified user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1users~1{id}~1profile_photo/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/users/{id}/profile_photo","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/users/{id}/profile_photo","href":"users/reset user profile photo","openApiOperationId":"Reset User Profile Photo","summary":"Reset Profile Photo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"User has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users~1{id}~1profile_photo/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users/{id}/profile_photo"},{"label":"Update Profile Photo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/update user profile photo","routeSlug":"/kantata/specification/users/update user profile photo","metadata":{"seo":{"title":"Update Profile Photo","description":"Update the profile photo for the specified user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update User Profile Photo","name":"Update Profile Photo","isWebhook":false,"pointer":"/paths/~1users~1{id}~1profile_photo/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Profile Photo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the profile photo for the specified user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1users~1{id}~1profile_photo/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `manager` (User) - Retrieves the user's manager. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `role` (Role) - Retrieves the user's account role. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user's proficiency level (for skills which can be assigned proficiency levels).\n- `skills` (Skill) - Retrieves the user's skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.\n- `work_samples` (WorkSample) - Retrieves the user's portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_365","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1users~1{id}~1profile_photo/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_370"}},"schemaId":"schema_370","pointer":"/paths/~1users~1{id}~1profile_photo/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{id}/profile_photo","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_365","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_370"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/users/{id}/profile_photo","href":"users/update user profile photo","openApiOperationId":"Update User Profile Photo","summary":"Update Profile Photo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_370","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_370"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users~1{id}~1profile_photo/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users/{id}/profile_photo"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"Users represent the individuals that are participating in Kantata OX projects . User objects are often returned as\nnested JSON objects within other returned items such as posts or tasks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users","summary":"Fetching visible users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get users","deprecated":false},{"title":"/users/me","summary":"Fetch your own data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get my user data","deprecated":false},{"title":"/users/{id}","summary":"Fetching a single User","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get user","deprecated":false},{"title":"/users/{id}","summary":"Updating an existing User","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/update user","deprecated":false},{"title":"/users/{id}/capacity","summary":"Fetch My Work Capacity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get my work capacity","deprecated":false},{"title":"/users/{id}/profile_photo","summary":"Reset Profile Photo","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/reset user profile photo","deprecated":false},{"title":"/users/{id}/profile_photo","summary":"Update Profile Photo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/update user profile photo","deprecated":false}]}]}]}]}},{"type":"separator","label":"Currencies","content":null},{"type":"group","label":"Currencies","link":"/kantata/specification/currencies","routeSlug":"/kantata/specification/currencies","items":[{"label":"Get a list of currencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/currencies/get currencies","routeSlug":"/kantata/specification/currencies/get currencies","metadata":{"seo":{"title":"Get a list of currencies","description":"Returns all currencies supported by Kantata OX, unless filter parameters have been applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Currencies","name":"Get a list of currencies","isWebhook":false,"pointer":"/paths/~1currencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of currencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all currencies supported by Kantata OX, unless filter parameters have been applied."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"addable_to_rate_card_set_version","in":"query","schemaId":"schema_313","description":"Filters for currencies that can be added to the rate card associated with the specified\n[Rate Card Set Version](/tag/Rate-Card-Set-Version-(Effective-version-by-Date)) ID.\nIf the associated rate card **is** the account default, all currencies supported by Kantata OX are returned.\n\nIf the associated rate card is **not** set as the account default, results are additionally limited\nto currencies on the account default rate card."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Filters for currencies that approximately match the specified value. Valid values are [ISO\ncodes, names, or symbols of currencies supported by Kantata OX](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473)."}],"pointer":"/paths/~1currencies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/currencies","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"addable_to_rate_card_set_version","in":"query","required":false,"schemaId":"schema_313"},{"name":"matching","in":"query","required":false,"schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/currencies","href":"currencies/get currencies","openApiOperationId":"Get Currencies","summary":"Get a list of currencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Currencies have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371"}},"schemaId":"schema_371"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1currencies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_371","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/currencies"}],"content":{"contentType":"group","meta":{"name":"Currencies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Currencies","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows you to view the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/360041576473"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"names, ISO codes, and symbols of currencies supported by Kantata OX"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/currencies","summary":"Get a list of currencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/currencies/get currencies","deprecated":false}]}]}]}]}},{"type":"separator","label":"Custom Fields","content":null},{"type":"group","label":"Custom Field Choices","link":"/kantata/specification/custom-field-choices","routeSlug":"/kantata/specification/custom-field-choices","items":[{"label":"Fetching a list of Custom Field Choices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-field-choices/get custom field choices","routeSlug":"/kantata/specification/custom-field-choices/get custom field choices","metadata":{"seo":{"title":"Fetching a list of Custom Field Choices","description":"Returns all possible choices for all 'single' and 'multi' type custom fields on the requester's account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Custom Field Choices","name":"Fetching a list of Custom Field Choices","isWebhook":false,"pointer":"/paths/~1custom_field_choices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Custom Field Choices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all possible choices for all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'single'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'multi'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type custom fields on the requester's account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Field Choice objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_field_choices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"active","in":"query","schemaId":"schema_305","description":"Only return non-obsolete custom field choices."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"for_choice_ids","in":"query","schemaId":"schema_304","description":"Only return custom field choices for these specific custom field choice ids formatted '1,2,...'."},{"name":"for_custom_fields","in":"query","schemaId":"schema_304","description":"Only return custom field choices for these specific custom field ids formatted '1,2,...'."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_field` (CustomField)\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Includes custom field choices with a name that matches the search string."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_372","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `label:asc`, `label:desc`, `position:asc`, and `position:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_custom_field","in":"query","schemaId":"schema_313","description":"Evenly distribute the choices fetched by their custom_field_id in groups the size of the number specified."},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1custom_field_choices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom_field_choices","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"active","in":"query","schemaId":"schema_305"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"for_choice_ids","in":"query","schemaId":"schema_304"},{"name":"for_custom_fields","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_372"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_custom_field","in":"query","schemaId":"schema_313"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_field_choices","href":"custom-field-choices/get custom field choices","openApiOperationId":"Get Custom Field Choices","summary":"Fetching a list of Custom Field Choices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Custom Field Choices have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_373"}},"schemaId":"schema_373"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_field_choices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_373","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_373"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_field_choices"}],"content":{"contentType":"group","meta":{"name":"Custom Field Choices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Field Choices","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Field Choices are possible values for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'single'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'multi'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type custom fields."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custom_field_choices","summary":"Fetching a list of Custom Field Choices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-field-choices/get custom field choices","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Field Sets","link":"/kantata/specification/custom-field-sets","routeSlug":"/kantata/specification/custom-field-sets","items":[{"label":"Fetching a list of Custom Field Sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-field-sets/get custom field sets","routeSlug":"/kantata/specification/custom-field-sets/get custom field sets","metadata":{"seo":{"title":"Fetching a list of Custom Field Sets","description":"This endpoint returns structured Custom Field Set objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the custom_field_sets top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Custom Field Sets","name":"Fetching a list of Custom Field Sets","isWebhook":false,"pointer":"/paths/~1custom_field_sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Custom Field Sets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Field Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_field_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_fields` (CustomField) - The custom fields that belonging to the custom field set.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `alphabetical:asc`, `alphabetical:desc`, `created_at:asc`, and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"with_subject_type","in":"query","schemaId":"schema_304","description":"Set by a specific subject type: Workspace, Story, User or WorkspaceGroup."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1custom_field_sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom_field_sets","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"with_subject_type","in":"query","schemaId":"schema_304"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_field_sets","href":"custom-field-sets/get custom field sets","openApiOperationId":"Get Custom Field Sets","summary":"Fetching a list of Custom Field Sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Custom Field Sets have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}},"schemaId":"schema_374"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_field_sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_374","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_field_sets"},{"label":"Creating a new Custom Field Set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-field-sets/create custom field set","routeSlug":"/kantata/specification/custom-field-sets/create custom field set","metadata":{"seo":{"title":"Creating a new Custom Field Set","description":"To create a custom field, the current user must be the Account Administrator."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Custom Field Set","name":"Creating a new Custom Field Set","isWebhook":false,"pointer":"/paths/~1custom_field_sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Custom Field Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a custom field, the current user must be the Account Administrator."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Field Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_field_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_fields` (CustomField) - The custom fields that belonging to the custom field set.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."}],"pointer":"/paths/~1custom_field_sets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_375"}},"schemaId":"schema_375","pointer":"/paths/~1custom_field_sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/custom_field_sets","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_375"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_field_sets","href":"custom-field-sets/create custom field set","openApiOperationId":"Create Custom Field Set","summary":"Creating a new Custom Field Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_375","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_375"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Custom Field Set has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}},"schemaId":"schema_374"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_field_sets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_374","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_field_sets"},{"label":"Fetching a single Custom Field Set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-field-sets/get custom field set","routeSlug":"/kantata/specification/custom-field-sets/get custom field set","metadata":{"seo":{"title":"Fetching a single Custom Field Set","description":"This endpoint returns structured Custom Field Set objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the custom_field_sets top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Custom Field Set","name":"Fetching a single Custom Field Set","isWebhook":false,"pointer":"/paths/~1custom_field_sets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Custom Field Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Field Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_field_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1custom_field_sets~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_fields` (CustomField) - The custom fields that belonging to the custom field set.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."}],"pointer":"/paths/~1custom_field_sets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom_field_sets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_field_sets/{id}","href":"custom-field-sets/get custom field set","openApiOperationId":"Get Custom Field Set","summary":"Fetching a single Custom Field Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Custom Field Set has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}},"schemaId":"schema_374"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_field_sets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_374","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_field_sets/{id}"},{"label":"Updating an existing Custom Field Set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-field-sets/update custom field set","routeSlug":"/kantata/specification/custom-field-sets/update custom field set","metadata":{"seo":{"title":"Updating an existing Custom Field Set","description":"To update a custom field, the current user must be the Account Administrator."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Custom Field Set","name":"Updating an existing Custom Field Set","isWebhook":false,"pointer":"/paths/~1custom_field_sets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Custom Field Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a custom field, the current user must be the Account Administrator."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Field Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_field_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1custom_field_sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_fields` (CustomField) - The custom fields that belonging to the custom field set.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."}],"pointer":"/paths/~1custom_field_sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_376"}},"schemaId":"schema_376","pointer":"/paths/~1custom_field_sets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/custom_field_sets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_376"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_field_sets/{id}","href":"custom-field-sets/update custom field set","openApiOperationId":"Update Custom Field Set","summary":"Updating an existing Custom Field Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_376","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_376"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Custom Field Set has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}},"schemaId":"schema_374"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_field_sets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_374","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_field_sets/{id}"},{"label":"Deleting an existing Custom Field Set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-field-sets/delete custom field set","routeSlug":"/kantata/specification/custom-field-sets/delete custom field set","metadata":{"seo":{"title":"Deleting an existing Custom Field Set","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Custom Field Set","name":"Deleting an existing Custom Field Set","isWebhook":false,"pointer":"/paths/~1custom_field_sets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Custom Field Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1custom_field_sets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/custom_field_sets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/custom_field_sets/{id}","href":"custom-field-sets/delete custom field set","openApiOperationId":"Delete Custom Field Set","summary":"Deleting an existing Custom Field Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Custom Field Set has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_field_sets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_field_sets/{id}"}],"content":{"contentType":"group","meta":{"name":"Custom Field Sets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Field Sets","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Field Sets contain custom fields and definitions of each fields' subject type. The supported"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subjects are currently "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workspace"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Story"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WorkspaceGroup"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custom_field_sets","summary":"Fetching a list of Custom Field Sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-field-sets/get custom field sets","deprecated":false},{"title":"/custom_field_sets","summary":"Creating a new Custom Field Set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-field-sets/create custom field set","deprecated":false},{"title":"/custom_field_sets/{id}","summary":"Fetching a single Custom Field Set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-field-sets/get custom field set","deprecated":false},{"title":"/custom_field_sets/{id}","summary":"Updating an existing Custom Field Set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-field-sets/update custom field set","deprecated":false},{"title":"/custom_field_sets/{id}","summary":"Deleting an existing Custom Field Set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-field-sets/delete custom field set","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Field Values","link":"/kantata/specification/custom-field-values","routeSlug":"/kantata/specification/custom-field-values","items":[{"label":"Fetching a list of Custom Field Values","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-field-values/get custom field values","routeSlug":"/kantata/specification/custom-field-values/get custom field values","metadata":{"seo":{"title":"Fetching a list of Custom Field Values","description":"Returns all values for the specified set ofCustom Fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Custom Field Values","name":"Fetching a list of Custom Field Values","isWebhook":false,"pointer":"/paths/~1custom_field_values/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Custom Field Values","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all values for the specified set of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/202924760-Custom-Fields-Overview-#arrange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has its own rate limit. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/9698066628123"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields are organized into "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Custom-Field-Sets"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sets"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by the objects they store additional information for (Estimate, Project, Group, Resource, Task, or User)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to specify which set of Custom Fields to return values for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Estimate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Story"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Task)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Workspace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Project)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WorkspaceGroup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Group)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom field values for "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"archived"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Projects and Tasks are included in returned values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values are sorted from less to more recently updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":5,"id":"custom-field-values/get custom field values/request/note:","deepLinkHash":"/custom-field-values/get custom field values#custom-field-values/get custom field values/request/note:"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission setting on each custom field"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"determines the minimum permission needed to view a custom field and its value."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Workspace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Project), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Resource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Story"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Task) custom fields are project-specific objects,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"so their minimum permissions are set at the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/115002779293-Project-Permissions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"project level"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_collaboration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_logging"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"financial"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_admin"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most account-level permissions supercede project-level permissions. Therefore, Account Administrators"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are able to view all Project, Resource, and Task custom fields and values across the account,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"regardless of project participation or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Estimate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WorkspaceGroup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Group), and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" custom fields are account-wide objects, so their minimum permissions are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set at the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/203041364"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account level"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_collaboration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_creator"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_lead"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reports_viewer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reports_viewer_with_cost"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Field Value objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_field_values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subject_type","in":"query","schemaId":"schema_304","description":"You must specify which set of Custom Fields to return values for:\n* `Estimate`\n* `Story` (Task)\n* `User`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`\n\nThis parameter is required.","required":true},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_field` (CustomField) - Retrieves the custom field the value is for. The response will include `custom_field_id`, which references the data in the `custom_fields` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `selected_choices` (CustomFieldChoice) - Retrieves the custom field choice that corresponds to the custom field value. The response will include `selected_choice_ids`, which references the data in the `custom_field_choices` top-level key.\n- `setter` (User) - Retrieves the user that set the custom field value. The response will include `setter_id`, which references the data in the `users` top-level key.\n- `subject` (polymorphic) - Retrieves the object which the custom field value is for. The response will include `subject_ref`, which references the data in the top-level key specified in the `key` field of `subject_ref`. The possible objects are as follows:\n* `Estimate`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`\n* `Story` (Task)\n* `User`."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_335","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `subject_id:asc`, `subject_id:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"with_custom_field_id","in":"query","schemaId":"schema_304","description":"Filters for values of the Custom Field(s) with the specified ID(s). Give multiple Custom Field IDs in a comma-separated list."},{"name":"with_setter_id","in":"query","schemaId":"schema_304","description":"Filters for Custom Field Values set by a user with the specified ID(s). Give multiple user IDs in a comma-separated list."},{"name":"with_subject_id","in":"query","schemaId":"schema_304","description":"Filters for Custom Field Values associated with the specified ID(s) of an Estimate, Project,\n Group, Resource, Task, or User. Give multiple IDs in a comma-separated list."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1custom_field_values/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom_field_values","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"subject_type","in":"query","required":true,"schemaId":"schema_304"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_335"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"with_custom_field_id","in":"query","schemaId":"schema_304"},{"name":"with_setter_id","in":"query","schemaId":"schema_304"},{"name":"with_subject_id","in":"query","schemaId":"schema_304"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_field_values","href":"custom-field-values/get custom field values","openApiOperationId":"Get Custom Field Values","summary":"Fetching a list of Custom Field Values"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Custom Field Values have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}},"schemaId":"schema_377"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_field_values/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_377","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_field_values"},{"label":"Creating a new Custom Field Value","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-field-values/create custom field value","routeSlug":"/kantata/specification/custom-field-values/create custom field value","metadata":{"seo":{"title":"Creating a new Custom Field Value","description":"Creates a new value for the specified custom field. Creating a value can also override existing values,effectively making this an update request as well."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Custom Field Value","name":"Creating a new Custom Field Value","isWebhook":false,"pointer":"/paths/~1custom_field_values/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Custom Field Value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new value for the specified custom field. Creating a value can also override existing values,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectively making this an update request as well."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Custom-Field-Choices"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single or multi choice values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"override existing values, note that new values are not "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"added"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to existing values, but instead "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replace"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" existing values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, every new value has a unique, new ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has its own rate limit. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/9698066628123"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create or Update"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating or updating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"custom_field_values\": [\n {\n \"subject_type\": \"Workspace\",\n \"subject_id\": 123,\n \"custom_field_id\": 456,\n \"value\": \"Hello world\"\n },\n {\n \"subject_type\": \"Workspace\",\n \"subject_id\": 123,\n \"custom_field_id\": 789,\n \"value\": \"Hello world\"\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"custom_field_values\": [\n {\n \"subject_type\": \"Workspace\",\n \"subject_id\": 123,\n \"custom_field_id\": 456,\n \"value\": \"Hello world\"\n },\n {\n \"subject_type\": \"Workspace\",\n \"subject_id\": 123,\n \"custom_field_id\": 789,\n \"value\": \"Hello world\"\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Field Value objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_field_values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_field` (CustomField) - Retrieves the custom field the value is for. The response will include `custom_field_id`, which references the data in the `custom_fields` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `selected_choices` (CustomFieldChoice) - Retrieves the custom field choice that corresponds to the custom field value. The response will include `selected_choice_ids`, which references the data in the `custom_field_choices` top-level key.\n- `setter` (User) - Retrieves the user that set the custom field value. The response will include `setter_id`, which references the data in the `users` top-level key.\n- `subject` (polymorphic) - Retrieves the object which the custom field value is for. The response will include `subject_ref`, which references the data in the top-level key specified in the `key` field of `subject_ref`. The possible objects are as follows:\n* `Estimate`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`\n* `Story` (Task)\n* `User`."}],"pointer":"/paths/~1custom_field_values/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_378"}},"schemaId":"schema_378","pointer":"/paths/~1custom_field_values/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/custom_field_values","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_378"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_field_values","href":"custom-field-values/create custom field value","openApiOperationId":"Create Custom Field Value","summary":"Creating a new Custom Field Value"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_378","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_378"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Custom Field Value has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}},"schemaId":"schema_377"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_field_values/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_377","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_field_values"},{"label":"Delete multiple custom field values","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-field-values/delete custom field values","routeSlug":"/kantata/specification/custom-field-values/delete custom field values","metadata":{"seo":{"title":"Delete multiple custom field values","description":"The IDs of the custom field values to delete can be provided in the ids query parameter or via the request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Custom Field Values","name":"Delete multiple custom field values","isWebhook":false,"pointer":"/paths/~1custom_field_values/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete multiple custom field values","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs of the custom field values to delete can be provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter or via the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" \"ids\": \"1,2,3\"\n}```\n\nIf any specified custom field values cannot be deleted, the entire request will fail and an error message\nwill be returned that specifies which ones could not be deleted and why.\n\n\nThis endpoint returns structured Custom Field Value objects.\nAs with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array\nand will be indexed by ID in the `custom_field_values` top-level JSON key.\nPlease see our [Response Format](#section/Response-Format) section for more information.","language":"{"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" \"ids\": \"1,2,3\"\n}```\n\nIf any specified custom field values cannot be deleted, the entire request will fail and an error message\nwill be returned that specifies which ones could not be deleted and why.\n\n\nThis endpoint returns structured Custom Field Value objects.\nAs with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array\nand will be indexed by ID in the `custom_field_values` top-level JSON key.\nPlease see our [Response Format](#section/Response-Format) section for more information."},"children":[]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ids","in":"query","schemaId":"schema_304","description":"A comma-separated list of IDs of custom field values. You can provide up to 100 IDs. The IDs can be\nprovided in this query parameter or via the request body."}],"pointer":"/paths/~1custom_field_values/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/custom_field_values","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"ids","in":"query","required":false,"schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/custom_field_values","href":"custom-field-values/delete custom field values","openApiOperationId":"Delete Custom Field Values","summary":"Delete multiple custom field values"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Custom Field Value has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_field_values/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_field_values"},{"label":"Fetching a single Custom Field Value","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-field-values/get custom field value","routeSlug":"/kantata/specification/custom-field-values/get custom field value","metadata":{"seo":{"title":"Fetching a single Custom Field Value","description":"This endpoint returns structured Custom Field Value objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the custom_field_values top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Custom Field Value","name":"Fetching a single Custom Field Value","isWebhook":false,"pointer":"/paths/~1custom_field_values~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Custom Field Value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Field Value objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_field_values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1custom_field_values~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_field` (CustomField) - Retrieves the custom field the value is for. The response will include `custom_field_id`, which references the data in the `custom_fields` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `selected_choices` (CustomFieldChoice) - Retrieves the custom field choice that corresponds to the custom field value. The response will include `selected_choice_ids`, which references the data in the `custom_field_choices` top-level key.\n- `setter` (User) - Retrieves the user that set the custom field value. The response will include `setter_id`, which references the data in the `users` top-level key.\n- `subject` (polymorphic) - Retrieves the object which the custom field value is for. The response will include `subject_ref`, which references the data in the top-level key specified in the `key` field of `subject_ref`. The possible objects are as follows:\n* `Estimate`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`\n* `Story` (Task)\n* `User`."}],"pointer":"/paths/~1custom_field_values~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom_field_values/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_field_values/{id}","href":"custom-field-values/get custom field value","openApiOperationId":"Get Custom Field Value","summary":"Fetching a single Custom Field Value"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Custom Field Value has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}},"schemaId":"schema_377"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_field_values~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_377","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_field_values/{id}"},{"label":"Updating an existing Custom Field Value","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-field-values/update custom field value","routeSlug":"/kantata/specification/custom-field-values/update custom field value","metadata":{"seo":{"title":"Updating an existing Custom Field Value","description":"Updates an existing value for the specified custom field. Up to 100 values can be updated at one time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Custom Field Value","name":"Updating an existing Custom Field Value","isWebhook":false,"pointer":"/paths/~1custom_field_values~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Custom Field Value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing value for the specified custom field. Up to 100 values can be updated at one time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Field Value objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_field_values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1custom_field_values~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_field` (CustomField) - Retrieves the custom field the value is for. The response will include `custom_field_id`, which references the data in the `custom_fields` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `selected_choices` (CustomFieldChoice) - Retrieves the custom field choice that corresponds to the custom field value. The response will include `selected_choice_ids`, which references the data in the `custom_field_choices` top-level key.\n- `setter` (User) - Retrieves the user that set the custom field value. The response will include `setter_id`, which references the data in the `users` top-level key.\n- `subject` (polymorphic) - Retrieves the object which the custom field value is for. The response will include `subject_ref`, which references the data in the top-level key specified in the `key` field of `subject_ref`. The possible objects are as follows:\n* `Estimate`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`\n* `Story` (Task)\n* `User`."}],"pointer":"/paths/~1custom_field_values~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_379"}},"schemaId":"schema_379","pointer":"/paths/~1custom_field_values~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/custom_field_values/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_379"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_field_values/{id}","href":"custom-field-values/update custom field value","openApiOperationId":"Update Custom Field Value","summary":"Updating an existing Custom Field Value"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_379","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_379"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Custom Field Value has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}},"schemaId":"schema_377"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_field_values~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_377","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_field_values/{id}"},{"label":"Deleting an existing Custom Field Value","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-field-values/delete custom field value","routeSlug":"/kantata/specification/custom-field-values/delete custom field value","metadata":{"seo":{"title":"Deleting an existing Custom Field Value","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Custom Field Value","name":"Deleting an existing Custom Field Value","isWebhook":false,"pointer":"/paths/~1custom_field_values~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Custom Field Value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1custom_field_values~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/custom_field_values/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/custom_field_values/{id}","href":"custom-field-values/delete custom field value","openApiOperationId":"Delete Custom Field Value","summary":"Deleting an existing Custom Field Value"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Custom Field Value has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_field_values~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_field_values/{id}"}],"content":{"contentType":"group","meta":{"name":"Custom Field Values"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Field Values","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Custom-Fields"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represent the fields themselves,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Field Values represent the values in/of those fields. The Custom Field Values object allows"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you to view, create, update, and delete these values."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custom_field_values","summary":"Fetching a list of Custom Field Values","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-field-values/get custom field values","deprecated":false},{"title":"/custom_field_values","summary":"Creating a new Custom Field Value","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-field-values/create custom field value","deprecated":false},{"title":"/custom_field_values","summary":"Delete multiple custom field values","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-field-values/delete custom field values","deprecated":false},{"title":"/custom_field_values/{id}","summary":"Fetching a single Custom Field Value","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-field-values/get custom field value","deprecated":false},{"title":"/custom_field_values/{id}","summary":"Updating an existing Custom Field Value","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-field-values/update custom field value","deprecated":false},{"title":"/custom_field_values/{id}","summary":"Deleting an existing Custom Field Value","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-field-values/delete custom field value","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Fields","link":"/kantata/specification/custom-fields","routeSlug":"/kantata/specification/custom-fields","items":[{"label":"Fetching a list of Custom Fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-fields/get custom fields","routeSlug":"/kantata/specification/custom-fields/get custom fields","metadata":{"seo":{"title":"Fetching a list of Custom Fields","description":"Returns all Custom Fields, unless filter parameters have been applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Custom Fields","name":"Fetching a list of Custom Fields","isWebhook":false,"pointer":"/paths/~1custom_fields/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Custom Fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all Custom Fields, unless filter parameters have been applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Field objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `choices` (CustomFieldChoice) - Includes the ID of a Custom Field's choices.\n- `creator` (User) - Includes the ID of a Custom Field's creator.\n- `custom_field_set` (CustomFieldSet) - Includes the ID of the Custom Field Set that a field belongs to.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Filter by custom fields with a name similar to the specified string."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_380","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `name:asc`, `name:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"subject_type","in":"query","schemaId":"schema_304","description":"Filters for the specified set of Custom Fields:\n* `Estimate`\n* `Story` (Task)\n* `User`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1custom_fields/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom_fields","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_380"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"subject_type","in":"query","schemaId":"schema_304"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_fields","href":"custom-fields/get custom fields","openApiOperationId":"Get Custom Fields","summary":"Fetching a list of Custom Fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Custom Fields have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_fields/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_fields"},{"label":"Creating a new Custom Field","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-fields/create custom field","routeSlug":"/kantata/specification/custom-fields/create custom field","metadata":{"seo":{"title":"Creating a new Custom Field","description":"This endpoint returns structured Custom Field objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the custom_fields top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Custom Field","name":"Creating a new Custom Field","isWebhook":false,"pointer":"/paths/~1custom_fields/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Custom Field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Field objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `choices` (CustomFieldChoice) - Includes the ID of a Custom Field's choices.\n- `creator` (User) - Includes the ID of a Custom Field's creator.\n- `custom_field_set` (CustomFieldSet) - Includes the ID of the Custom Field Set that a field belongs to.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."}],"pointer":"/paths/~1custom_fields/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382","pointer":"/paths/~1custom_fields/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/custom_fields","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_382"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_fields","href":"custom-fields/create custom field","openApiOperationId":"Create Custom Field","summary":"Creating a new Custom Field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_382"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Custom Field has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_fields/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_fields"},{"label":"Updating an existing Custom Field","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-fields/update custom field","routeSlug":"/kantata/specification/custom-fields/update custom field","metadata":{"seo":{"title":"Updating an existing Custom Field","description":"Updates an existing custom field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Custom Field","name":"Updating an existing Custom Field","isWebhook":false,"pointer":"/paths/~1custom_fields~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Custom Field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing custom field."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-fields/update custom field/request/parameters-that-cannot-be-updated","deepLinkHash":"/custom-fields/update custom field#custom-fields/update custom field/request/parameters-that-cannot-be-updated"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameters that cannot be updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unique_constraint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters cannot be updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They are set during the process of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Custom-Fields#operation/create-custom-field"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creating a custom field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-fields/update custom field/request/updating-choices","deepLinkHash":"/custom-fields/update custom field#custom-fields/update custom field/request/updating-choices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating choices"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint also allows you to update the list of choices for a custom field with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Custom-Field-Choices"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single or multiple choices"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For important details"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"regarding how this endpoint affects the list of available choices and how to avoid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creating duplicate choices, see the description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"choice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Custom Field objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1custom_fields~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `choices` (CustomFieldChoice) - Includes the ID of a Custom Field's choices.\n- `creator` (User) - Includes the ID of a Custom Field's creator.\n- `custom_field_set` (CustomFieldSet) - Includes the ID of the Custom Field Set that a field belongs to.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."}],"pointer":"/paths/~1custom_fields~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_383"}},"schemaId":"schema_383","pointer":"/paths/~1custom_fields~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/custom_fields/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_383"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/custom_fields/{id}","href":"custom-fields/update custom field","openApiOperationId":"Update Custom Field","summary":"Updating an existing Custom Field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_383","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_383"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Custom Field has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_fields~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_fields/{id}"},{"label":"Deleting an existing Custom Field","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/custom-fields/delete custom field","routeSlug":"/kantata/specification/custom-fields/delete custom field","metadata":{"seo":{"title":"Deleting an existing Custom Field","description":"Deletes a custom field. Custom field values are deleted with their custom fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Custom Field","name":"Deleting an existing Custom Field","isWebhook":false,"pointer":"/paths/~1custom_fields~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Custom Field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a custom field. Custom field values are deleted with their custom fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1custom_fields~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/custom_fields/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/custom_fields/{id}","href":"custom-fields/delete custom field","openApiOperationId":"Delete Custom Field","summary":"Deleting an existing Custom Field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Custom Field has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1custom_fields~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/custom_fields/{id}"}],"content":{"contentType":"group","meta":{"name":"Custom Fields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Fields","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/202924760-Custom-Fields-Overview-#arrange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object allows you to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"view, create, update, and delete extra fields for additional Estimate, Project, Group, Resource, Task, and User information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Custom Fields represent the fields themselves, "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Custom-Field-Values"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Field Values"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"represent the values in/of those fields."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custom_fields","summary":"Fetching a list of Custom Fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-fields/get custom fields","deprecated":false},{"title":"/custom_fields","summary":"Creating a new Custom Field","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-fields/create custom field","deprecated":false},{"title":"/custom_fields/{id}","summary":"Updating an existing Custom Field","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-fields/update custom field","deprecated":false},{"title":"/custom_fields/{id}","summary":"Deleting an existing Custom Field","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-fields/delete custom field","deprecated":false}]}]}]}]}},{"type":"separator","label":"Data Exporter","content":null},{"type":"group","label":"Data Export Schema","link":"/kantata/specification/data-export-schema","routeSlug":"/kantata/specification/data-export-schema","items":[{"label":"Get Data Set Schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/data-export-schema/get exports available datasets","routeSlug":"/kantata/specification/data-export-schema/get exports available datasets","metadata":{"seo":{"title":"Get Data Set Schema","description":"Returns a list of the available data sets to export—as well as the respective available columns within each data set, which could include custom fields. The response will include unique key values for each individual data set and for each column. You will need to properly pass these keys in when you generate your data export."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Exports Available Datasets","name":"Get Data Set Schema","isWebhook":false,"pointer":"/paths/~1exports~1available_datasets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Data Set Schema","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of the available data sets to export—as well as the respective available columns within each data set, which could include custom fields. The response will include unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values for each individual data set and for each column. You will need to properly pass these keys in when you generate your data export."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/exports/available_datasets","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/exports/available_datasets","href":"data-export-schema/get exports available datasets","openApiOperationId":"Get Exports Available Datasets","summary":"Get Data Set Schema"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Data Export Schemas have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}},"schemaId":"schema_384"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1exports~1available_datasets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_384","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/exports/available_datasets"}],"content":{"contentType":"group","meta":{"name":"Data Export Schema"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Export Schema","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows you to export specific data sets from Kantata OX. You can view the full schema of available data sets using this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this endpoint, you need to be an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/203041364"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account administrator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/exports/available_datasets","summary":"Get Data Set Schema","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-export-schema/get exports available datasets","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Exports","link":"/kantata/specification/data-exports","routeSlug":"/kantata/specification/data-exports","items":[{"label":"Get a list of Data Exports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/data-exports/get exports","routeSlug":"/kantata/specification/data-exports/get exports","metadata":{"seo":{"title":"Get a list of Data Exports","description":"Returns information on all exports that have been requested, including their status and the data sets and columns that were selected for the exports."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Exports","name":"Get a list of Data Exports","isWebhook":false,"pointer":"/paths/~1exports/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of Data Exports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns information on all exports that have been requested, including their status and the data sets and columns that were selected for the exports."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Data Export objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - The user who generated the export."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1exports/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/exports","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/exports","href":"data-exports/get exports","openApiOperationId":"Get Exports","summary":"Get a list of Data Exports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Data Exports have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1exports/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/exports"},{"label":"Generate a Data Export","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/data-exports/create export","routeSlug":"/kantata/specification/data-exports/create export","metadata":{"seo":{"title":"Generate a Data Export","description":"Generates an export. Use the data set key and each column key that you want to be included in your export. The values need to be properly formatted JSON, which means you may need to escape special characters. If no column keys are provided, the export will fail and return a 422 response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Export","name":"Generate a Data Export","isWebhook":false,"pointer":"/paths/~1exports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a Data Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates an export. Use the data set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and each column "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that you want to be included in your export. The values need to be properly formatted JSON, which means you may need to escape special characters. If no column keys are provided, the export will fail and return a 422 response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following example creates a new export containing all the non-custom field columns for the User dataset created during October 2023."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -i -X POST 'https://api.mavenlink.com/api/v1/exports' -H 'Content-Type: application/json' -d '{\n \"export\": {\n \"export_definition\": {\n \"8ebff9db413b3115\": {\n \"columns\": [\n \"4eb02f5e2601433d\",\n \"b02d7f145ad95122\",\n \"2bfa2c20999efe62\",\n \"96cb337e5007738b\",\n \"27e2565ae34ed9eb\",\n \"d5111608cc214c2a\",\n \"e59d1cb61256a8cf\",\n \"77bfd7e48d5ff668\",\n \"23ca4c0d7b289c5f\",\n \"7172de0607dcb1ef\"\n ],\n \"filters\": {\n \"start_date\": \"2023-10-01\",\n \"end_date\": \"2023-10-31\"\n }\n }\n }\n }\n}'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -i -X POST 'https://api.mavenlink.com/api/v1/exports' -H 'Content-Type: application/json' -d '{\n \"export\": {\n \"export_definition\": {\n \"8ebff9db413b3115\": {\n \"columns\": [\n \"4eb02f5e2601433d\",\n \"b02d7f145ad95122\",\n \"2bfa2c20999efe62\",\n \"96cb337e5007738b\",\n \"27e2565ae34ed9eb\",\n \"d5111608cc214c2a\",\n \"e59d1cb61256a8cf\",\n \"77bfd7e48d5ff668\",\n \"23ca4c0d7b289c5f\",\n \"7172de0607dcb1ef\"\n ],\n \"filters\": {\n \"start_date\": \"2023-10-01\",\n \"end_date\": \"2023-10-31\"\n }\n }\n }\n }\n}'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Data Export objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - The user who generated the export."}],"pointer":"/paths/~1exports/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"schemaId":"schema_386","pointer":"/paths/~1exports/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/exports","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_386"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/exports","href":"data-exports/create export","openApiOperationId":"Create Export","summary":"Generate a Data Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_386","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Data Export has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1exports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/exports"},{"label":"Get a single Data Export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/data-exports/get export","routeSlug":"/kantata/specification/data-exports/get export","metadata":{"seo":{"title":"Get a single Data Export","description":"Returns information on a single export that has been requested, including the status and the data sets and columns that were selected for the export."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Export","name":"Get a single Data Export","isWebhook":false,"pointer":"/paths/~1exports~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single Data Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns information on a single export that has been requested, including the status and the data sets and columns that were selected for the export."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Data Export objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1exports~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - The user who generated the export."}],"pointer":"/paths/~1exports~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/exports/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/exports/{id}","href":"data-exports/get export","openApiOperationId":"Get Export","summary":"Get a single Data Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Data Export has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1exports~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/exports/{id}"},{"label":"Cancel a Data Export","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/data-exports/update export","routeSlug":"/kantata/specification/data-exports/update export","metadata":{"seo":{"title":"Cancel a Data Export","description":"Cancel an export that is in a Queued status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Export","name":"Cancel a Data Export","isWebhook":false,"pointer":"/paths/~1exports~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a Data Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel an export that is in a Queued status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Data Export objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1exports~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - The user who generated the export."}],"pointer":"/paths/~1exports~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_387","pointer":"/paths/~1exports~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/exports/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_387"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/exports/{id}","href":"data-exports/update export","openApiOperationId":"Update Export","summary":"Cancel a Data Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_387","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_387"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Data Export has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1exports~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/exports/{id}"},{"label":"Download a Data Export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/data-exports/download export","routeSlug":"/kantata/specification/data-exports/download export","metadata":{"seo":{"title":"Download a Data Export","description":"Returns a download URL for a successfully generated data export that expires in 60 seconds. With this URL, you can use curl or wget to download the export in a CSV format."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Download Export","name":"Download a Data Export","isWebhook":false,"pointer":"/paths/~1exports~1{id}~1download_url/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a Data Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a download URL for a successfully generated data export that expires in 60 seconds. With this URL, you can use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wget"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to download the export in a CSV format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Data Export objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1exports~1{id}~1download_url/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - The user who generated the export."}],"pointer":"/paths/~1exports~1{id}~1download_url/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/exports/{id}/download_url","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/exports/{id}/download_url","href":"data-exports/download export","openApiOperationId":"Download Export","summary":"Download a Data Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Data Exports have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1exports~1{id}~1download_url/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/exports/{id}/download_url"}],"content":{"contentType":"group","meta":{"name":"Data Exports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Exports","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows you to export specific data sets from Kantata OX. You can create or cancel exports. You can also view the full schema of available data sets, view details for all exports, and download exports."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use these endpoints, you need to be an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/203041364"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account administrator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/exports","summary":"Get a list of Data Exports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-exports/get exports","deprecated":false},{"title":"/exports","summary":"Generate a Data Export","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-exports/create export","deprecated":false},{"title":"/exports/{id}","summary":"Get a single Data Export","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-exports/get export","deprecated":false},{"title":"/exports/{id}","summary":"Cancel a Data Export","prefix":{"name":"put","color":"put"},"badges":[],"link":"/data-exports/update export","deprecated":false},{"title":"/exports/{id}/download_url","summary":"Download a Data Export","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-exports/download export","deprecated":false}]}]}]}]}},{"type":"separator","label":"Estimates","content":null},{"type":"group","label":"Estimate Scenario Resource Allocations","link":"/kantata/specification/estimate-scenario-resource-allocations","routeSlug":"/kantata/specification/estimate-scenario-resource-allocations","items":[{"label":"Updating an existing Estimate Scenario Resource Allocation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimate-scenario-resource-allocations/update estimate scenario resource allocation","routeSlug":"/kantata/specification/estimate-scenario-resource-allocations/update estimate scenario resource allocation","metadata":{"seo":{"title":"Updating an existing Estimate Scenario Resource Allocation","description":"This endpoint returns structured Estimate Scenario Resource Allocation objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the estimate_scenario_resource_allocations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Estimate Scenario Resource Allocation","name":"Updating an existing Estimate Scenario Resource Allocation","isWebhook":false,"pointer":"/paths/~1estimate_scenario_resource_allocations~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Estimate Scenario Resource Allocation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate Scenario Resource Allocation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimate_scenario_resource_allocations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1estimate_scenario_resource_allocations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `resource` (EstimateScenarioResource) - The scenario resource that owns the estimate scenario resource allocation."}],"pointer":"/paths/~1estimate_scenario_resource_allocations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_389"}},"schemaId":"schema_389","pointer":"/paths/~1estimate_scenario_resource_allocations~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/estimate_scenario_resource_allocations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_389"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimate_scenario_resource_allocations/{id}","href":"estimate-scenario-resource-allocations/update estimate scenario resource allocation","openApiOperationId":"Update Estimate Scenario Resource Allocation","summary":"Updating an existing Estimate Scenario Resource Allocation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_389","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_389"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estimate Scenario Resource Allocation has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390"}},"schemaId":"schema_390"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimate_scenario_resource_allocations~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_390","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimate_scenario_resource_allocations/{id}"}],"content":{"contentType":"group","meta":{"name":"Estimate Scenario Resource Allocations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Estimate Scenario Resource Allocations","showPageActions":true},{"nodeType":"markdoc","content":"Estimate Scenario Resource Allocations contain time-related data for scenario resources,\nused for calculating estimated cost and scheduled hours."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/estimate_scenario_resource_allocations/{id}","summary":"Updating an existing Estimate Scenario Resource Allocation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/estimate-scenario-resource-allocations/update estimate scenario resource allocation","deprecated":false}]}]}]}]}},{"type":"group","label":"Estimate Scenario Resources","link":"/kantata/specification/estimate-scenario-resources","routeSlug":"/kantata/specification/estimate-scenario-resources","items":[{"label":"Fetching a list of Estimate Scenario Resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimate-scenario-resources/get estimate scenario resources","routeSlug":"/kantata/specification/estimate-scenario-resources/get estimate scenario resources","metadata":{"seo":{"title":"Fetching a list of Estimate Scenario Resources","description":"This endpoint provides a list of all scenario resources associated with the specified estimatescenario."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Estimate Scenario Resources","name":"Fetching a list of Estimate Scenario Resources","isWebhook":false,"pointer":"/paths/~1estimate_scenario_resources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Estimate Scenario Resources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint provides a list of all scenario resources associated with the specified estimate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scenario."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate Scenario Resource objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimate_scenario_resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"estimate_scenario_id","in":"query","schemaId":"schema_313","description":"Required to retrieve the resources for a specified estimate scenario.","required":true},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `allocation` (EstimateScenarioResourceAllocation) - The Estimate Scenario Resource Allocation of the Estimate Scenario Resource.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `geography` (Geography) - The Geography of the Estimate Scenario Resource.\n- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.\n- `role` (Role)\n- `user` (User)."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `alphabetically:asc`, `alphabetically:desc`, `created_at:asc`, `created_at:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1estimate_scenario_resources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/estimate_scenario_resources","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"estimate_scenario_id","in":"query","required":true,"schemaId":"schema_313"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimate_scenario_resources","href":"estimate-scenario-resources/get estimate scenario resources","openApiOperationId":"Get Estimate Scenario Resources","summary":"Fetching a list of Estimate Scenario Resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Estimate Scenario Resources have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392"}},"schemaId":"schema_392"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimate_scenario_resources/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_392","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimate_scenario_resources"},{"label":"Creating a new Estimate Scenario Resource","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimate-scenario-resources/create estimate scenario resource","routeSlug":"/kantata/specification/estimate-scenario-resources/create estimate scenario resource","metadata":{"seo":{"title":"Creating a new Estimate Scenario Resource","description":"This endpoint returns structured Estimate Scenario Resource objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the estimate_scenario_resources top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Estimate Scenario Resource","name":"Creating a new Estimate Scenario Resource","isWebhook":false,"pointer":"/paths/~1estimate_scenario_resources/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Estimate Scenario Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate Scenario Resource objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimate_scenario_resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `allocation` (EstimateScenarioResourceAllocation) - The Estimate Scenario Resource Allocation of the Estimate Scenario Resource.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `geography` (Geography) - The Geography of the Estimate Scenario Resource.\n- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.\n- `role` (Role)\n- `user` (User)."}],"pointer":"/paths/~1estimate_scenario_resources/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_393"}},"schemaId":"schema_393","pointer":"/paths/~1estimate_scenario_resources/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/estimate_scenario_resources","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_393"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimate_scenario_resources","href":"estimate-scenario-resources/create estimate scenario resource","openApiOperationId":"Create Estimate Scenario Resource","summary":"Creating a new Estimate Scenario Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_393","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_393"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estimate Scenario Resource has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392"}},"schemaId":"schema_392"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimate_scenario_resources/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_392","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimate_scenario_resources"},{"label":"Fetching a single Estimate Scenario Resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimate-scenario-resources/get estimate scenario resource","routeSlug":"/kantata/specification/estimate-scenario-resources/get estimate scenario resource","metadata":{"seo":{"title":"Fetching a single Estimate Scenario Resource","description":"This endpoint returns structured Estimate Scenario Resource objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the estimate_scenario_resources top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Estimate Scenario Resource","name":"Fetching a single Estimate Scenario Resource","isWebhook":false,"pointer":"/paths/~1estimate_scenario_resources~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Estimate Scenario Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate Scenario Resource objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimate_scenario_resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1estimate_scenario_resources~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `allocation` (EstimateScenarioResourceAllocation) - The Estimate Scenario Resource Allocation of the Estimate Scenario Resource.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `geography` (Geography) - The Geography of the Estimate Scenario Resource.\n- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.\n- `role` (Role)\n- `user` (User)."}],"pointer":"/paths/~1estimate_scenario_resources~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/estimate_scenario_resources/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimate_scenario_resources/{id}","href":"estimate-scenario-resources/get estimate scenario resource","openApiOperationId":"Get Estimate Scenario Resource","summary":"Fetching a single Estimate Scenario Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Estimate Scenario Resource has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392"}},"schemaId":"schema_392"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimate_scenario_resources~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_392","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimate_scenario_resources/{id}"},{"label":"Updating an existing Estimate Scenario Resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimate-scenario-resources/update estimate scenario resource","routeSlug":"/kantata/specification/estimate-scenario-resources/update estimate scenario resource","metadata":{"seo":{"title":"Updating an existing Estimate Scenario Resource","description":"This endpoint returns structured Estimate Scenario Resource objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the estimate_scenario_resources top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Estimate Scenario Resource","name":"Updating an existing Estimate Scenario Resource","isWebhook":false,"pointer":"/paths/~1estimate_scenario_resources~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Estimate Scenario Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate Scenario Resource objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimate_scenario_resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1estimate_scenario_resources~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `allocation` (EstimateScenarioResourceAllocation) - The Estimate Scenario Resource Allocation of the Estimate Scenario Resource.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `geography` (Geography) - The Geography of the Estimate Scenario Resource.\n- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.\n- `role` (Role)\n- `user` (User)."}],"pointer":"/paths/~1estimate_scenario_resources~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_394"}},"schemaId":"schema_394","pointer":"/paths/~1estimate_scenario_resources~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/estimate_scenario_resources/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_394"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimate_scenario_resources/{id}","href":"estimate-scenario-resources/update estimate scenario resource","openApiOperationId":"Update Estimate Scenario Resource","summary":"Updating an existing Estimate Scenario Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_394","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_394"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estimate Scenario Resource has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392"}},"schemaId":"schema_392"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimate_scenario_resources~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_392","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimate_scenario_resources/{id}"},{"label":"Deleting an existing Estimate Scenario Resource","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimate-scenario-resources/delete estimate scenario resource","routeSlug":"/kantata/specification/estimate-scenario-resources/delete estimate scenario resource","metadata":{"seo":{"title":"Deleting an existing Estimate Scenario Resource","description":"This will delete an estimate scenario resource and its allocations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Estimate Scenario Resource","name":"Deleting an existing Estimate Scenario Resource","isWebhook":false,"pointer":"/paths/~1estimate_scenario_resources~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Estimate Scenario Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will delete an estimate scenario resource and its allocations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1estimate_scenario_resources~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/estimate_scenario_resources/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/estimate_scenario_resources/{id}","href":"estimate-scenario-resources/delete estimate scenario resource","openApiOperationId":"Delete Estimate Scenario Resource","summary":"Deleting an existing Estimate Scenario Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Estimate Scenario Resource has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimate_scenario_resources~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimate_scenario_resources/{id}"}],"content":{"contentType":"group","meta":{"name":"Estimate Scenario Resources"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Estimate Scenario Resources","showPageActions":true},{"nodeType":"markdoc","content":"Estimate Scenario Resources represent placeholders for unnamed resources in a specific estimate scenario."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/estimate_scenario_resources","summary":"Fetching a list of Estimate Scenario Resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/estimate-scenario-resources/get estimate scenario resources","deprecated":false},{"title":"/estimate_scenario_resources","summary":"Creating a new Estimate Scenario Resource","prefix":{"name":"post","color":"post"},"badges":[],"link":"/estimate-scenario-resources/create estimate scenario resource","deprecated":false},{"title":"/estimate_scenario_resources/{id}","summary":"Fetching a single Estimate Scenario Resource","prefix":{"name":"get","color":"get"},"badges":[],"link":"/estimate-scenario-resources/get estimate scenario resource","deprecated":false},{"title":"/estimate_scenario_resources/{id}","summary":"Updating an existing Estimate Scenario Resource","prefix":{"name":"put","color":"put"},"badges":[],"link":"/estimate-scenario-resources/update estimate scenario resource","deprecated":false},{"title":"/estimate_scenario_resources/{id}","summary":"Deleting an existing Estimate Scenario Resource","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/estimate-scenario-resources/delete estimate scenario resource","deprecated":false}]}]}]}]}},{"type":"group","label":"Estimate Scenarios","link":"/kantata/specification/estimate-scenarios","routeSlug":"/kantata/specification/estimate-scenarios","items":[{"label":"Fetching a list of Estimate Scenarios","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimate-scenarios/get estimate scenarios","routeSlug":"/kantata/specification/estimate-scenarios/get estimate scenarios","metadata":{"seo":{"title":"Fetching a list of Estimate Scenarios","description":"This endpoint returns structured Estimate Scenario objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the estimate_scenarios top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Estimate Scenarios","name":"Fetching a list of Estimate Scenarios","isWebhook":false,"pointer":"/paths/~1estimate_scenarios/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Estimate Scenarios","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate Scenario objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimate_scenarios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `estimate_scenario_resources` (EstimateScenarioResource) - The Estimate Scenario Resources of the Estimate Scenario.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `rate_card` (RateCard) - The rate card being used for the estimate scenario."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_312","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `name:asc` and `name:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1estimate_scenarios/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/estimate_scenarios","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_312"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimate_scenarios","href":"estimate-scenarios/get estimate scenarios","openApiOperationId":"Get Estimate Scenarios","summary":"Fetching a list of Estimate Scenarios"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Estimate Scenarios have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimate_scenarios/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimate_scenarios"},{"label":"Creating a new Estimate Scenario","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimate-scenarios/create estimate scenario","routeSlug":"/kantata/specification/estimate-scenarios/create estimate scenario","metadata":{"seo":{"title":"Creating a new Estimate Scenario","description":"This endpoint returns structured Estimate Scenario objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the estimate_scenarios top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Estimate Scenario","name":"Creating a new Estimate Scenario","isWebhook":false,"pointer":"/paths/~1estimate_scenarios/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Estimate Scenario","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate Scenario objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimate_scenarios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `estimate_scenario_resources` (EstimateScenarioResource) - The Estimate Scenario Resources of the Estimate Scenario.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `rate_card` (RateCard) - The rate card being used for the estimate scenario."}],"pointer":"/paths/~1estimate_scenarios/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_396"}},"schemaId":"schema_396","pointer":"/paths/~1estimate_scenarios/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/estimate_scenarios","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_396"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimate_scenarios","href":"estimate-scenarios/create estimate scenario","openApiOperationId":"Create Estimate Scenario","summary":"Creating a new Estimate Scenario"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_396","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_396"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estimate Scenario has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimate_scenarios/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimate_scenarios"},{"label":"Fetching a single Estimate Scenario","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimate-scenarios/get estimate scenario","routeSlug":"/kantata/specification/estimate-scenarios/get estimate scenario","metadata":{"seo":{"title":"Fetching a single Estimate Scenario","description":"This endpoint returns structured Estimate Scenario objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the estimate_scenarios top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Estimate Scenario","name":"Fetching a single Estimate Scenario","isWebhook":false,"pointer":"/paths/~1estimate_scenarios~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Estimate Scenario","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate Scenario objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimate_scenarios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1estimate_scenarios~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `estimate_scenario_resources` (EstimateScenarioResource) - The Estimate Scenario Resources of the Estimate Scenario.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `rate_card` (RateCard) - The rate card being used for the estimate scenario."}],"pointer":"/paths/~1estimate_scenarios~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/estimate_scenarios/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimate_scenarios/{id}","href":"estimate-scenarios/get estimate scenario","openApiOperationId":"Get Estimate Scenario","summary":"Fetching a single Estimate Scenario"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Estimate Scenario has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimate_scenarios~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimate_scenarios/{id}"},{"label":"Updating an existing Estimate Scenario","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimate-scenarios/update estimate scenario","routeSlug":"/kantata/specification/estimate-scenarios/update estimate scenario","metadata":{"seo":{"title":"Updating an existing Estimate Scenario","description":"This endpoint returns structured Estimate Scenario objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the estimate_scenarios top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Estimate Scenario","name":"Updating an existing Estimate Scenario","isWebhook":false,"pointer":"/paths/~1estimate_scenarios~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Estimate Scenario","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate Scenario objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimate_scenarios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1estimate_scenarios~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `estimate_scenario_resources` (EstimateScenarioResource) - The Estimate Scenario Resources of the Estimate Scenario.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `rate_card` (RateCard) - The rate card being used for the estimate scenario."}],"pointer":"/paths/~1estimate_scenarios~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_397"}},"schemaId":"schema_397","pointer":"/paths/~1estimate_scenarios~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/estimate_scenarios/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_397"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimate_scenarios/{id}","href":"estimate-scenarios/update estimate scenario","openApiOperationId":"Update Estimate Scenario","summary":"Updating an existing Estimate Scenario"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_397","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_397"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estimate Scenario has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimate_scenarios~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimate_scenarios/{id}"},{"label":"Deleting an existing Estimate Scenario","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimate-scenarios/delete estimate scenario","routeSlug":"/kantata/specification/estimate-scenarios/delete estimate scenario","metadata":{"seo":{"title":"Deleting an existing Estimate Scenario","description":"Deletes an estimate scenario, including all of its resources and their allocations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Estimate Scenario","name":"Deleting an existing Estimate Scenario","isWebhook":false,"pointer":"/paths/~1estimate_scenarios~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Estimate Scenario","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an estimate scenario, including all of its resources and their allocations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1estimate_scenarios~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/estimate_scenarios/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/estimate_scenarios/{id}","href":"estimate-scenarios/delete estimate scenario","openApiOperationId":"Delete Estimate Scenario","summary":"Deleting an existing Estimate Scenario"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Estimate Scenario has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimate_scenarios~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimate_scenarios/{id}"}],"content":{"contentType":"group","meta":{"name":"Estimate Scenarios"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Estimate Scenarios","showPageActions":true},{"nodeType":"markdoc","content":"An Estimate Scenario is a possible project configuration, consisting of an estimated budget,\nrate card, resources, and other related fields for a specified estimate."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/estimate_scenarios","summary":"Fetching a list of Estimate Scenarios","prefix":{"name":"get","color":"get"},"badges":[],"link":"/estimate-scenarios/get estimate scenarios","deprecated":false},{"title":"/estimate_scenarios","summary":"Creating a new Estimate Scenario","prefix":{"name":"post","color":"post"},"badges":[],"link":"/estimate-scenarios/create estimate scenario","deprecated":false},{"title":"/estimate_scenarios/{id}","summary":"Fetching a single Estimate Scenario","prefix":{"name":"get","color":"get"},"badges":[],"link":"/estimate-scenarios/get estimate scenario","deprecated":false},{"title":"/estimate_scenarios/{id}","summary":"Updating an existing Estimate Scenario","prefix":{"name":"put","color":"put"},"badges":[],"link":"/estimate-scenarios/update estimate scenario","deprecated":false},{"title":"/estimate_scenarios/{id}","summary":"Deleting an existing Estimate Scenario","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/estimate-scenarios/delete estimate scenario","deprecated":false}]}]}]}]}},{"type":"group","label":"Estimates","link":"/kantata/specification/estimates","routeSlug":"/kantata/specification/estimates","items":[{"label":"Fetching a list of Estimates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimates/get estimates","routeSlug":"/kantata/specification/estimates/get estimates","metadata":{"seo":{"title":"Fetching a list of Estimates","description":"This endpoint returns structured Estimate objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the estimates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Estimates","name":"Fetching a list of Estimates","isWebhook":false,"pointer":"/paths/~1estimates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Estimates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field choice value, represented as a string with the custom field ID, followed by a\ncolon, and then comma-separated custom field choice value IDs. The custom field choice value can also be\nthe word `blank`. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\n\nThe following formats are supported:\n\n- `custom_field_ID:choice_value_ID`\n- `custom_field_ID:choice_value_1_ID,choice_value_2_ID`\n- `custom_field_ID:blank`\n- `(custom_field_1_ID:choice_value_1_ID,choice_value_2_ID):(custom_field_2_ID:choice_value_3_ID)`."},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field currency value, represented as a string with the custom field ID, followed by a\ncolon, and then the currency value. Optionally, the currency [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473) can be supplied as well, separated\nfrom the currency value by another colon. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200.2:USD):(2:100)`."},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field date value, represented as a string with the custom field ID, followed by a\ncolon, the starting date, another colon, and then the ending date. You can provide both a starting date\nand ending date, or provide just one. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:2014-12-05:2014-12-25):(2:2014-12-05)`."},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field number value, represented as a string with the custom field ID, followed by a\ncolon, and then the number value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200):(2:101)`."},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field text value, represented as a string with the custom field ID, followed by a\ncolon, and then the text value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:something):(2:else)`\n- `(1:something):(1:else)` (multiple values for the same field, returns objects matching any value)\n- `1` (bare field ID with no value, returns all objects that have any value for that field)."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"creator","in":"query","schemaId":"schema_304","description":"Only includes estimates in which the specified set IDs belong to the creator of the estimates. For example, '10,20'."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304","description":"Filter by the presence of a custom field value for the specified comma-separated custom field ID(s)."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user who created the estimate.\n- `custom_field_values` (CustomFieldValue) - The value set on estimate custom fields.\n- `estimate_scenarios` (EstimateScenario) - The EstimateScenarios of the estimate.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `workspace` (Workspace) - The Workspace that was created from the Project.\n- `workspace_group` (WorkspaceGroup) - The WorkspaceGroup (client) of the estimate."},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_312","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `name:asc`, and `name:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"with_workspace_group_ids","in":"query","schemaId":"schema_304","description":"Only includes estimates for the specified workspace group IDs. For example, '1,2,3'."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1estimates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/estimates","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"creator","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_312"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"with_workspace_group_ids","in":"query","schemaId":"schema_304"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimates","href":"estimates/get estimates","openApiOperationId":"Get Estimates","summary":"Fetching a list of Estimates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Estimates have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimates"},{"label":"Creating a new Estimate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimates/create estimate","routeSlug":"/kantata/specification/estimates/create estimate","metadata":{"seo":{"title":"Creating a new Estimate","description":"This endpoint returns structured Estimate objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the estimates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Estimate","name":"Creating a new Estimate","isWebhook":false,"pointer":"/paths/~1estimates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Estimate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user who created the estimate.\n- `custom_field_values` (CustomFieldValue) - The value set on estimate custom fields.\n- `estimate_scenarios` (EstimateScenario) - The EstimateScenarios of the estimate.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `workspace` (Workspace) - The Workspace that was created from the Project.\n- `workspace_group` (WorkspaceGroup) - The WorkspaceGroup (client) of the estimate."}],"pointer":"/paths/~1estimates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_399"}},"schemaId":"schema_399","pointer":"/paths/~1estimates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/estimates","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_399"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimates","href":"estimates/create estimate","openApiOperationId":"Create Estimate","summary":"Creating a new Estimate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_399","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_399"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estimate has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimates"},{"label":"Fetching a single Estimate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimates/get estimate","routeSlug":"/kantata/specification/estimates/get estimate","metadata":{"seo":{"title":"Fetching a single Estimate","description":"This endpoint returns structured Estimate objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the estimates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Estimate","name":"Fetching a single Estimate","isWebhook":false,"pointer":"/paths/~1estimates~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Estimate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1estimates~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user who created the estimate.\n- `custom_field_values` (CustomFieldValue) - The value set on estimate custom fields.\n- `estimate_scenarios` (EstimateScenario) - The EstimateScenarios of the estimate.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `workspace` (Workspace) - The Workspace that was created from the Project.\n- `workspace_group` (WorkspaceGroup) - The WorkspaceGroup (client) of the estimate."}],"pointer":"/paths/~1estimates~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/estimates/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimates/{id}","href":"estimates/get estimate","openApiOperationId":"Get Estimate","summary":"Fetching a single Estimate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Estimate has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimates~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimates/{id}"},{"label":"Updating an existing Estimate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimates/update estimate","routeSlug":"/kantata/specification/estimates/update estimate","metadata":{"seo":{"title":"Updating an existing Estimate","description":"This endpoint returns structured Estimate objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the estimates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Estimate","name":"Updating an existing Estimate","isWebhook":false,"pointer":"/paths/~1estimates~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Estimate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Estimate objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1estimates~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user who created the estimate.\n- `custom_field_values` (CustomFieldValue) - The value set on estimate custom fields.\n- `estimate_scenarios` (EstimateScenario) - The EstimateScenarios of the estimate.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `workspace` (Workspace) - The Workspace that was created from the Project.\n- `workspace_group` (WorkspaceGroup) - The WorkspaceGroup (client) of the estimate."}],"pointer":"/paths/~1estimates~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","pointer":"/paths/~1estimates~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/estimates/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_400"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/estimates/{id}","href":"estimates/update estimate","openApiOperationId":"Update Estimate","summary":"Updating an existing Estimate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estimate has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimates~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimates/{id}"},{"label":"Deleting an existing Estimate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/estimates/delete estimate","routeSlug":"/kantata/specification/estimates/delete estimate","metadata":{"seo":{"title":"Deleting an existing Estimate","description":"Deletes the estimate and it's associated scenarios, scenario resources,and scenario resource allocations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Estimate","name":"Deleting an existing Estimate","isWebhook":false,"pointer":"/paths/~1estimates~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Estimate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the estimate and it's associated scenarios, scenario resources,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and scenario resource allocations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1estimates~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/estimates/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/estimates/{id}","href":"estimates/delete estimate","openApiOperationId":"Delete Estimate","summary":"Deleting an existing Estimate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Estimate has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1estimates~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/estimates/{id}"}],"content":{"contentType":"group","meta":{"name":"Estimates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Estimates","showPageActions":true},{"nodeType":"markdoc","content":"An Estimate represents a potential project. Estimates allow you to plan out a project's budget, resources,\nand allocations through associated estimate scenarios."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/estimates","summary":"Fetching a list of Estimates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/estimates/get estimates","deprecated":false},{"title":"/estimates","summary":"Creating a new Estimate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/estimates/create estimate","deprecated":false},{"title":"/estimates/{id}","summary":"Fetching a single Estimate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/estimates/get estimate","deprecated":false},{"title":"/estimates/{id}","summary":"Updating an existing Estimate","prefix":{"name":"put","color":"put"},"badges":[],"link":"/estimates/update estimate","deprecated":false},{"title":"/estimates/{id}","summary":"Deleting an existing Estimate","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/estimates/delete estimate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Expense Budgets","content":null},{"type":"group","label":"Expense Budgets","link":"/kantata/specification/expense-budgets","routeSlug":"/kantata/specification/expense-budgets","items":[{"label":"Fetching a list of Expense Budgets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-budgets/get expense budgets","routeSlug":"/kantata/specification/expense-budgets/get expense budgets","metadata":{"seo":{"title":"Fetching a list of Expense Budgets","description":"Gets a list of expense budgets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Expense Budgets","name":"Fetching a list of Expense Budgets","isWebhook":false,"pointer":"/paths/~1expense_budgets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Expense Budgets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a list of expense budgets."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Budgets objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_budgets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `expenses` (Expense) - The expenses associated with the expense budget.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `fixed_fee_items` (FixedFeeItem) - The fixed fee items associated with the expense budget.\n- `story` (Story) - Retrieves the associated story (task). The response will include `story_id`, which references the data in the `stories` top-level key.\n- `workspace` (Workspace) - Retrieves the workspace (project) the expense budget is on. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Filter by workspace ID."}],"pointer":"/paths/~1expense_budgets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/expense_budgets","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_budgets","href":"expense-budgets/get expense budgets","openApiOperationId":"Get Expense Budgets","summary":"Fetching a list of Expense Budgets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Expense Budgets have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}},"schemaId":"schema_401"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_budgets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_budgets"},{"label":"Creating a new Expense Budgets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-budgets/create expense budget","routeSlug":"/kantata/specification/expense-budgets/create expense budget","metadata":{"seo":{"title":"Creating a new Expense Budgets","description":"Creates a new expense budget.The following combinations of fixed_fee, burns_budget, and billable are allowed:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Expense Budget","name":"Creating a new Expense Budgets","isWebhook":false,"pointer":"/paths/~1expense_budgets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Expense Budgets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new expense budget."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following combinations of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"burns_budget"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are allowed:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"burns_budget"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Known as a fixed fee budget"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"burns_budget"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Known as an itemized budget"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"burns_budget"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only: Known as a cost-only budget"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only: Known as a pass-through budget"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Known as a pass-through fixed fee budget"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Budgets objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_budgets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `expenses` (Expense) - The expenses associated with the expense budget.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `fixed_fee_items` (FixedFeeItem) - The fixed fee items associated with the expense budget.\n- `story` (Story) - Retrieves the associated story (task). The response will include `story_id`, which references the data in the `stories` top-level key.\n- `workspace` (Workspace) - Retrieves the workspace (project) the expense budget is on. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."}],"pointer":"/paths/~1expense_budgets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_402"}},"schemaId":"schema_402","pointer":"/paths/~1expense_budgets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/expense_budgets","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_402"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_budgets","href":"expense-budgets/create expense budget","openApiOperationId":"Create Expense Budget","summary":"Creating a new Expense Budgets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_402","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_402"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Expense Budgets has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}},"schemaId":"schema_401"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_budgets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_budgets"},{"label":"Fetching a single Expense Budgets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-budgets/get expense budget","routeSlug":"/kantata/specification/expense-budgets/get expense budget","metadata":{"seo":{"title":"Fetching a single Expense Budgets","description":"Gets a single expense budget."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Expense Budget","name":"Fetching a single Expense Budgets","isWebhook":false,"pointer":"/paths/~1expense_budgets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Expense Budgets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a single expense budget."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Budgets objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_budgets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1expense_budgets~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `expenses` (Expense) - The expenses associated with the expense budget.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `fixed_fee_items` (FixedFeeItem) - The fixed fee items associated with the expense budget.\n- `story` (Story) - Retrieves the associated story (task). The response will include `story_id`, which references the data in the `stories` top-level key.\n- `workspace` (Workspace) - Retrieves the workspace (project) the expense budget is on. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."}],"pointer":"/paths/~1expense_budgets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/expense_budgets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_budgets/{id}","href":"expense-budgets/get expense budget","openApiOperationId":"Get Expense Budget","summary":"Fetching a single Expense Budgets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Expense Budgets has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}},"schemaId":"schema_401"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_budgets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_budgets/{id}"},{"label":"Updating an existing Expense Budgets","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-budgets/update expense budget","routeSlug":"/kantata/specification/expense-budgets/update expense budget","metadata":{"seo":{"title":"Updating an existing Expense Budgets","description":"Updates an expense budget."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Expense Budget","name":"Updating an existing Expense Budgets","isWebhook":false,"pointer":"/paths/~1expense_budgets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Expense Budgets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an expense budget."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Budgets objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_budgets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1expense_budgets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `expenses` (Expense) - The expenses associated with the expense budget.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `fixed_fee_items` (FixedFeeItem) - The fixed fee items associated with the expense budget.\n- `story` (Story) - Retrieves the associated story (task). The response will include `story_id`, which references the data in the `stories` top-level key.\n- `workspace` (Workspace) - Retrieves the workspace (project) the expense budget is on. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."}],"pointer":"/paths/~1expense_budgets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_403"}},"schemaId":"schema_403","pointer":"/paths/~1expense_budgets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/expense_budgets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_403"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_budgets/{id}","href":"expense-budgets/update expense budget","openApiOperationId":"Update Expense Budget","summary":"Updating an existing Expense Budgets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_403","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_403"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Expense Budgets has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}},"schemaId":"schema_401"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_budgets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_budgets/{id}"},{"label":"Deleting an existing Expense Budgets","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-budgets/delete expense budget","routeSlug":"/kantata/specification/expense-budgets/delete expense budget","metadata":{"seo":{"title":"Deleting an existing Expense Budgets","description":"Deletes an expense budget. An expense budget cannot be deleted if there are expenses logged to it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Expense Budget","name":"Deleting an existing Expense Budgets","isWebhook":false,"pointer":"/paths/~1expense_budgets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Expense Budgets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an expense budget. An expense budget cannot be deleted if there are expenses logged to it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1expense_budgets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/expense_budgets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/expense_budgets/{id}","href":"expense-budgets/delete expense budget","openApiOperationId":"Delete Expense Budget","summary":"Deleting an existing Expense Budgets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Expense Budgets has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_budgets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_budgets/{id}"}],"content":{"contentType":"group","meta":{"name":"Expense Budgets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Expense Budgets","showPageActions":true},{"nodeType":"markdoc","content":"Expense budgets allow you to plan for non-labor expenses."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/expense_budgets","summary":"Fetching a list of Expense Budgets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/expense-budgets/get expense budgets","deprecated":false},{"title":"/expense_budgets","summary":"Creating a new Expense Budgets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/expense-budgets/create expense budget","deprecated":false},{"title":"/expense_budgets/{id}","summary":"Fetching a single Expense Budgets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/expense-budgets/get expense budget","deprecated":false},{"title":"/expense_budgets/{id}","summary":"Updating an existing Expense Budgets","prefix":{"name":"put","color":"put"},"badges":[],"link":"/expense-budgets/update expense budget","deprecated":false},{"title":"/expense_budgets/{id}","summary":"Deleting an existing Expense Budgets","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/expense-budgets/delete expense budget","deprecated":false}]}]}]}]}},{"type":"separator","label":"Expense Tracking","content":null},{"type":"group","label":"Attachments","link":"/kantata/specification/attachments","routeSlug":"/kantata/specification/attachments","items":[{"label":"Creating a new Attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/attachments/create attachment","routeSlug":"/kantata/specification/attachments/create attachment","metadata":{"seo":{"title":"Creating a new Attachment","description":"There are two different ways to upload file attachments. Direct CDN upload, or Kantata OX server upload."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Attachment","name":"Creating a new Attachment","isWebhook":false,"pointer":"/paths/~1attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two different ways to upload file attachments. Direct CDN upload, or Kantata OX server upload."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"attachments/create attachment/request/attachments/create attachment/request/direct-cdn-upload","deepLinkHash":"/attachments/create attachment#attachments/create attachment/request/attachments/create attachment/request/direct-cdn-upload"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct CDN Upload"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploading directly to the CDN is a three step process but allows for faster uploading, significantly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"larger attachments, and more accurate upload progress information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieving upload credentials has two required fields, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must include two attributes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required) must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"post_attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required) is the filename of the file to be uploaded."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file name must not contain spaces or special characters other than an underscore (\"_\") or a hyphen (\"-\"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"otherwise the file upload will fail."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After successfully creating an attachment, an upload url and credentials will be returned in JSON format"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with an HTTP 200 status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --form \"direct=true\" --form \"attachment[filename]=attachment.doc\"\n--form \"attachment[type]=post_attachment\" \"https://api.mavenlink.com/api/v1/attachments.json\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --form \"direct=true\" --form \"attachment[filename]=attachment.doc\"\n--form \"attachment[type]=post_attachment\" \"https://api.mavenlink.com/api/v1/attachments.json\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response JSON will then contain the information to upload the file:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"id\": 2,\n \"action\": \"[upload url]\",\n \"fields\":{\n \"utf8\": \"✓\",\n \"key\": \" ... \",\n \"Content-Disposition\": \"attachment; filename=\"attachment.doc\"; filename*=UTF-8''attachment.doc\",\n \"success_action_status\": 201,\n \"AWSAccessKeyId\": \" ... \",\n \"acl\": \"private\",\n \"policy\": \" ... \",\n \"signature\": \" ... \"\n }\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"id\": 2,\n \"action\": \"[upload url]\",\n \"fields\":{\n \"utf8\": \"✓\",\n \"key\": \" ... \",\n \"Content-Disposition\": \"attachment; filename=\"attachment.doc\"; filename*=UTF-8''attachment.doc\",\n \"success_action_status\": 201,\n \"AWSAccessKeyId\": \" ... \",\n \"acl\": \"private\",\n \"policy\": \" ... \",\n \"signature\": \" ... \"\n }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A second POST request can then be made to the provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the field values"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned in the JSON response, in addition to the file data. The AWSAccessKeyId field value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is only active for 5 seconds, so these consecutive calls are meant to be made in quick succession via a script."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$file"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", variables in the request that start with $ are the values represented by the \" ... \" blanks in the JSON response."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \"[upload url]\" -H 'cache-control: no-cache' --form 'AWSAccessKeyId='$awsKey --form 'Content-Disposition=\"attachment; filename=\"$file\"; filename*=UTF-8''''''$file\"' --form 'x-amz-server-side-encryption=AES256' --form 'key='$key --form 'policy='$policy --form 'signature='$sig --form 'acl=private' --form 'success_action_status=201' --form 'utf8=✓' --form 'file=@'$file\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \"[upload url]\" -H 'cache-control: no-cache' --form 'AWSAccessKeyId='$awsKey --form 'Content-Disposition=\"attachment; filename=\"$file\"; filename*=UTF-8''''''$file\"' --form 'x-amz-server-side-encryption=AES256' --form 'key='$key --form 'policy='$policy --form 'signature='$sig --form 'acl=private' --form 'success_action_status=201' --form 'utf8=✓' --form 'file=@'$file\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finally, once the upload has completed successfully, a 'sync' request (specified below) is necessary to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mark the upload as complete."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Below is a simplified example using ruby to achieve the same thing as with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" commands above:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"#!/usr/bin/env ruby\n\nrequire 'net/https'\nrequire \"uri\"\nrequire 'json'\n\nTOKEN=\"Bearer \"\nATTACHMENTS_ENDPOINT=\"https://api.mavenlink.com/api/v1/attachments.json\"\nBOUNDARY = \"AaB03x\" # Make sure it is not present in the file you're uploading.\n\nfile = ARGV[0]\nfilename = File.basename(file)\n\nuri = URI.parse(ATTACHMENTS_ENDPOINT)\nhttp = Net::HTTP.new(uri.host, uri.port)\nhttp.use_ssl = true\nrequest = Net::HTTP::Post.new(uri.request_uri)\nrequest['Authorization'] = TOKEN\nrequest.set_form_data(first_request_params)\nresponse = http.request(request)\nfirst_response = JSON.parse(response.body)\n\n# for the second request we manually build the request body\npost_body = []\n\nsecond_request_params = first_response[\"fields\"].merge({ \"file\" => File.open(file) })\nsecond_request_params.each do |k,v|\n post_body << \"--#{BOUNDARY}\\r\\n\"\n if v.is_a?(IO)\n post_body << \"Content-Disposition: form-data; name=\"#{k}\"; filename=\"#{filename}\"\\r\\n\"\n post_body << \"\\r\\n\"\n post_body << File.read(file)\n post_body << \"\\r\\n\"\n else\n post_body << \"Content-Disposition: form-data; name=\"#{k}\"\\r\\n\\r\\n\"\n post_body << v.to_s + \"\\r\\n\"\n end\nend\n\npost_body << \"--#{BOUNDARY}--\\r\\n\"\n\nuri = URI.parse(first_response[\"action\"])\nhttp = Net::HTTP.new(uri.host, uri.port)\nhttp.use_ssl = true\nrequest = Net::HTTP::Post.new(uri.request_uri)\nrequest.body = post_body.join\nrequest[\"Content-Type\"] = \"multipart/form-data, boundary=#{BOUNDARY}\"\nresponse = http.request(request)\n\nexit(response.code == second_request_params[\"success_action_status\"].to_s)\n","language":"ruby"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"#!/usr/bin/env ruby\n\nrequire 'net/https'\nrequire \"uri\"\nrequire 'json'\n\nTOKEN=\"Bearer \"\nATTACHMENTS_ENDPOINT=\"https://api.mavenlink.com/api/v1/attachments.json\"\nBOUNDARY = \"AaB03x\" # Make sure it is not present in the file you're uploading.\n\nfile = ARGV[0]\nfilename = File.basename(file)\n\nuri = URI.parse(ATTACHMENTS_ENDPOINT)\nhttp = Net::HTTP.new(uri.host, uri.port)\nhttp.use_ssl = true\nrequest = Net::HTTP::Post.new(uri.request_uri)\nrequest['Authorization'] = TOKEN\nrequest.set_form_data(first_request_params)\nresponse = http.request(request)\nfirst_response = JSON.parse(response.body)\n\n# for the second request we manually build the request body\npost_body = []\n\nsecond_request_params = first_response[\"fields\"].merge({ \"file\" => File.open(file) })\nsecond_request_params.each do |k,v|\n post_body << \"--#{BOUNDARY}\\r\\n\"\n if v.is_a?(IO)\n post_body << \"Content-Disposition: form-data; name=\"#{k}\"; filename=\"#{filename}\"\\r\\n\"\n post_body << \"\\r\\n\"\n post_body << File.read(file)\n post_body << \"\\r\\n\"\n else\n post_body << \"Content-Disposition: form-data; name=\"#{k}\"\\r\\n\\r\\n\"\n post_body << v.to_s + \"\\r\\n\"\n end\nend\n\npost_body << \"--#{BOUNDARY}--\\r\\n\"\n\nuri = URI.parse(first_response[\"action\"])\nhttp = Net::HTTP.new(uri.host, uri.port)\nhttp.use_ssl = true\nrequest = Net::HTTP::Post.new(uri.request_uri)\nrequest.body = post_body.join\nrequest[\"Content-Type\"] = \"multipart/form-data, boundary=#{BOUNDARY}\"\nresponse = http.request(request)\n\nexit(response.code == second_request_params[\"success_action_status\"].to_s)\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"attachments/create attachment/request/attachments/create attachment/request/syncing-a-created-attachment","deepLinkHash":"/attachments/create attachment#attachments/create attachment/request/attachments/create attachment/request/syncing-a-created-attachment"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Syncing a created Attachment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Syncing marks an upload as complete, and verifies its existence on the CDN."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sync request can be made as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X PUT \"https://api.mavenlink.com/api/v1/attachments/2/sync.json\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X PUT \"https://api.mavenlink.com/api/v1/attachments/2/sync.json\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"attachments/create attachment/request/attachments/create attachment/request/kantata-ox-server-upload","deepLinkHash":"/attachments/create attachment#attachments/create attachment/request/attachments/create attachment/request/kantata-ox-server-upload"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kantata OX Server Upload"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For small attachments (< 10MB), you may upload to our servers and skip the 3-step direct CDN upload process."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Doing so requires one field, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with two required attributes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required) must be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"post_attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required) is the multipart/form-data encoded file contents."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After successfully creating an attachment its metadata will be returned in JSON format with an HTTP 200"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status code. To upload a file using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" utility, you would run a command like this one:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --form \"attachment[data]=@test.rb\" --form \"attachment[type]=post_attachment\" \"https://api.mavenlink.com/api/v1/attachments.json\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --form \"attachment[data]=@test.rb\" --form \"attachment[type]=post_attachment\" \"https://api.mavenlink.com/api/v1/attachments.json\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Attachment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_404"}},"schemaId":"schema_404","pointer":"/paths/~1attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/attachments","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_404"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/attachments","href":"attachments/create attachment","openApiOperationId":"Create Attachment","summary":"Creating a new Attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_404","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_404"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}},"schemaId":"schema_405"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_405","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/attachments"},{"label":"Updating an existing Attachment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/attachments/update attachment","routeSlug":"/kantata/specification/attachments/update attachment","metadata":{"seo":{"title":"Updating an existing Attachment","description":"This endpoint returns structured Attachment objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the attachments top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Attachment","name":"Updating an existing Attachment","isWebhook":false,"pointer":"/paths/~1attachments~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Attachment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1attachments~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"schemaId":"schema_406","pointer":"/paths/~1attachments~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/attachments/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_406"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/attachments/{id}","href":"attachments/update attachment","openApiOperationId":"Update Attachment","summary":"Updating an existing Attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}},"schemaId":"schema_405"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1attachments~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_405","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/attachments/{id}"},{"label":"Deleting an existing Attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/attachments/delete attachment","routeSlug":"/kantata/specification/attachments/delete attachment","metadata":{"seo":{"title":"Deleting an existing Attachment","description":"Destroys an attachment from its subject object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Attachment","name":"Deleting an existing Attachment","isWebhook":false,"pointer":"/paths/~1attachments~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destroys an attachment from its subject object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1attachments~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/attachments/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/attachments/{id}","href":"attachments/delete attachment","openApiOperationId":"Delete Attachment","summary":"Deleting an existing Attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Attachment has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1attachments~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/attachments/{id}"},{"label":"Sync a created attachment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/attachments/sync attachment","routeSlug":"/kantata/specification/attachments/sync attachment","metadata":{"seo":{"title":"Sync a created attachment","description":"Marks an upload as complete, and verifies its existence on the CDN."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Sync Attachment","name":"Sync a created attachment","isWebhook":false,"pointer":"/paths/~1attachments~1{id}~1sync/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync a created attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marks an upload as complete, and verifies its existence on the CDN."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Attachment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1attachments~1{id}~1sync/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/attachments/{id}/sync","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/attachments/{id}/sync","href":"attachments/sync attachment","openApiOperationId":"Sync Attachment","summary":"Sync a created attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}},"schemaId":"schema_405"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1attachments~1{id}~1sync/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_405","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/attachments/{id}/sync"}],"content":{"contentType":"group","meta":{"name":"Attachments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attachments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An Attachment is a file asset that is attached to another Kantata OX object. Depending on the type of object,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the file is used or displayed in different ways. The objects that Attachments can be attached to are:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Post and Expense."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create an Expense or Post with an Attachment, use the resulting attachment_id from the Attachment creation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request in the parameters of the Expense or Post creation request."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/attachments","summary":"Creating a new Attachment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/attachments/create attachment","deprecated":false},{"title":"/attachments/{id}","summary":"Updating an existing Attachment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/attachments/update attachment","deprecated":false},{"title":"/attachments/{id}","summary":"Deleting an existing Attachment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/attachments/delete attachment","deprecated":false},{"title":"/attachments/{id}/sync","summary":"Sync a created attachment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/attachments/sync attachment","deprecated":false}]}]}]}]}},{"type":"group","label":"Expense Categories","link":"/kantata/specification/expense-categories","routeSlug":"/kantata/specification/expense-categories","items":[{"label":"Fetching a list of Expense Categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-categories/get expense categories","routeSlug":"/kantata/specification/expense-categories/get expense categories","metadata":{"seo":{"title":"Fetching a list of Expense Categories","description":"This endpoint returns structured Expense Category objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the expense_categories top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Expense Categories","name":"Fetching a list of Expense Categories","isWebhook":false,"pointer":"/paths/~1expense_categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Expense Categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Category objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"matching","in":"query","schemaId":"schema_304","description":"By expense category names that match the specified name."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"only_active","in":"query","schemaId":"schema_321","description":"Only include expense categories that have not been deleted (deleted_at is NULL)."},{"name":"order","in":"query","schemaId":"schema_343","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `alphabetical:asc` and `alphabetical:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1expense_categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/expense_categories","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"only_active","in":"query","schemaId":"schema_321"},{"name":"order","in":"query","schemaId":"schema_343"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_categories","href":"expense-categories/get expense categories","openApiOperationId":"Get Expense Categories","summary":"Fetching a list of Expense Categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Expense Categories have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}},"schemaId":"schema_407"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_407","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_categories"},{"label":"Creating a new Expense Category","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-categories/create expense category","routeSlug":"/kantata/specification/expense-categories/create expense category","metadata":{"seo":{"title":"Creating a new Expense Category","description":"This endpoint returns structured Expense Category objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the expense_categories top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Expense Category","name":"Creating a new Expense Category","isWebhook":false,"pointer":"/paths/~1expense_categories/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Expense Category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Category objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_408"}},"schemaId":"schema_408","pointer":"/paths/~1expense_categories/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/expense_categories","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_408"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_categories","href":"expense-categories/create expense category","openApiOperationId":"Create Expense Category","summary":"Creating a new Expense Category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_408","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_408"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Expense Category has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}},"schemaId":"schema_407"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_categories/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_407","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_categories"},{"label":"Updating an existing Expense Category","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-categories/update expense category","routeSlug":"/kantata/specification/expense-categories/update expense category","metadata":{"seo":{"title":"Updating an existing Expense Category","description":"This endpoint returns structured Expense Category objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the expense_categories top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Expense Category","name":"Updating an existing Expense Category","isWebhook":false,"pointer":"/paths/~1expense_categories~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Expense Category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Category objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1expense_categories~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","pointer":"/paths/~1expense_categories~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/expense_categories/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_409"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_categories/{id}","href":"expense-categories/update expense category","openApiOperationId":"Update Expense Category","summary":"Updating an existing Expense Category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_409"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Expense Category has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}},"schemaId":"schema_407"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_categories~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_407","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_categories/{id}"},{"label":"Deleting an existing Expense Category","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-categories/delete expense category","routeSlug":"/kantata/specification/expense-categories/delete expense category","metadata":{"seo":{"title":"Deleting an existing Expense Category","description":"Deleting an expense category updates the deleted_at attribute to the current time. Deletedexpense categories are not included by default in the index action and can be retrieved by settingonly_active filter as false."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Expense Category","name":"Deleting an existing Expense Category","isWebhook":false,"pointer":"/paths/~1expense_categories~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Expense Category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleting an expense category updates the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleted_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute to the current time. Deleted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expense categories are not included by default in the index action and can be retrieved by setting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"only_active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter as false."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1expense_categories~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/expense_categories/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/expense_categories/{id}","href":"expense-categories/delete expense category","openApiOperationId":"Delete Expense Category","summary":"Deleting an existing Expense Category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Expense Category has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_categories~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_categories/{id}"}],"content":{"contentType":"group","meta":{"name":"Expense Categories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Expense Categories","showPageActions":true},{"nodeType":"markdoc","content":"An Expense Category represents the type of expense that is being reported.\nExpense categories have no attributes and consist of just their name\nas a string. They can be changed by Account Administrators."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/expense_categories","summary":"Fetching a list of Expense Categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/expense-categories/get expense categories","deprecated":false},{"title":"/expense_categories","summary":"Creating a new Expense Category","prefix":{"name":"post","color":"post"},"badges":[],"link":"/expense-categories/create expense category","deprecated":false},{"title":"/expense_categories/{id}","summary":"Updating an existing Expense Category","prefix":{"name":"put","color":"put"},"badges":[],"link":"/expense-categories/update expense category","deprecated":false},{"title":"/expense_categories/{id}","summary":"Deleting an existing Expense Category","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/expense-categories/delete expense category","deprecated":false}]}]}]}]}},{"type":"group","label":"Expense Report Submissions","link":"/kantata/specification/expense-report-submissions","routeSlug":"/kantata/specification/expense-report-submissions","items":[{"label":"Fetching a list of Expense Report Submissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-report-submissions/get expense report submissions","routeSlug":"/kantata/specification/expense-report-submissions/get expense report submissions","metadata":{"seo":{"title":"Fetching a list of Expense Report Submissions","description":"Returns expense report submissions for the logged in user by default. When all_on_account filter is setto true, the endpoint returns all expense report submissions on the account visible to the user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Expense Report Submissions","name":"Fetching a list of Expense Report Submissions","isWebhook":false,"pointer":"/paths/~1expense_report_submissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Expense Report Submissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns expense report submissions for the logged in user by default. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all_on_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter is set"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to true, the endpoint returns all expense report submissions on the account visible to the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Report Submission objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_report_submissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"active","in":"query","schemaId":"schema_305","description":"Returns only active submissions."},{"name":"all_on_account","in":"query","schemaId":"schema_351","description":"Return expense report submissions on the account."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `expenses` (Expense) - Include expense line items with the expense report submission.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `resolutions` (Resolution) - Include the resolutions (approvals, rejections, or cancelations).\n- `user` (User) - Includes user who owns the line items on the submission.\n- `workspace` (Workspace) - Includes workspace to which the submission belongs."},{"name":"not_cancelled","in":"query","schemaId":"schema_305","description":"Returns only submissions that are not cancelled."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `amount:asc`, `amount:desc`, `created_at:asc`, `created_at:desc`, `date:asc`, `date:desc`, `status:asc`, `status:desc`, `title:asc`, `title:desc`, `workspace_title:asc`, and `workspace_title:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"statuses","in":"query","schemaId":"schema_304","description":"Returns submissions with the statuses specified. Multiple statuses can be supplied in a comma separated list.\nValid values: ‘new’, ‘cancelled’, ‘rejected’, and ‘approved’."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"user_ids","in":"query","schemaId":"schema_304","description":"Only includes submissions associated with the specified user ids."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Ordered by the submission's workspace id."},{"name":"workspace_ids","in":"query","schemaId":"schema_304","description":"Only includes submissions associated with the specified workspace ids."}],"pointer":"/paths/~1expense_report_submissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/expense_report_submissions","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"active","in":"query","schemaId":"schema_305"},{"name":"all_on_account","in":"query","required":false,"schemaId":"schema_351"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"not_cancelled","in":"query","schemaId":"schema_305"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"statuses","in":"query","schemaId":"schema_304"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"user_ids","in":"query","schemaId":"schema_304"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","schemaId":"schema_313"},{"name":"workspace_ids","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_report_submissions","href":"expense-report-submissions/get expense report submissions","openApiOperationId":"Get Expense Report Submissions","summary":"Fetching a list of Expense Report Submissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Expense Report Submissions have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}},"schemaId":"schema_410"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_report_submissions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_410","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_report_submissions"},{"label":"Creating a new Expense Report Submission","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-report-submissions/create expense report submission","routeSlug":"/kantata/specification/expense-report-submissions/create expense report submission","metadata":{"seo":{"title":"Creating a new Expense Report Submission","description":"This endpoint returns structured Expense Report Submission objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the expense_report_submissions top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Expense Report Submission","name":"Creating a new Expense Report Submission","isWebhook":false,"pointer":"/paths/~1expense_report_submissions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Expense Report Submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Report Submission objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_report_submissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `expenses` (Expense) - Include expense line items with the expense report submission.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `resolutions` (Resolution) - Include the resolutions (approvals, rejections, or cancelations).\n- `user` (User) - Includes user who owns the line items on the submission.\n- `workspace` (Workspace) - Includes workspace to which the submission belongs."}],"pointer":"/paths/~1expense_report_submissions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_411"}},"schemaId":"schema_411","pointer":"/paths/~1expense_report_submissions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/expense_report_submissions","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_411"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_report_submissions","href":"expense-report-submissions/create expense report submission","openApiOperationId":"Create Expense Report Submission","summary":"Creating a new Expense Report Submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_411","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_411"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Expense Report Submission has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}},"schemaId":"schema_410"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_report_submissions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_410","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_report_submissions"},{"label":"Fetching a single Expense Report Submission","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-report-submissions/get expense report submission","routeSlug":"/kantata/specification/expense-report-submissions/get expense report submission","metadata":{"seo":{"title":"Fetching a single Expense Report Submission","description":"This endpoint returns structured Expense Report Submission objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the expense_report_submissions top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Expense Report Submission","name":"Fetching a single Expense Report Submission","isWebhook":false,"pointer":"/paths/~1expense_report_submissions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Expense Report Submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Report Submission objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_report_submissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1expense_report_submissions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `expenses` (Expense) - Include expense line items with the expense report submission.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `resolutions` (Resolution) - Include the resolutions (approvals, rejections, or cancelations).\n- `user` (User) - Includes user who owns the line items on the submission.\n- `workspace` (Workspace) - Includes workspace to which the submission belongs."}],"pointer":"/paths/~1expense_report_submissions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/expense_report_submissions/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_report_submissions/{id}","href":"expense-report-submissions/get expense report submission","openApiOperationId":"Get Expense Report Submission","summary":"Fetching a single Expense Report Submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Expense Report Submission has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}},"schemaId":"schema_410"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_report_submissions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_410","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_report_submissions/{id}"},{"label":"Approve an Expense Report Submission","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-report-submissions/approve expense report submission","routeSlug":"/kantata/specification/expense-report-submissions/approve expense report submission","metadata":{"seo":{"title":"Approve an Expense Report Submission","description":"You can approve an Expense Report Submission by accessing the approve endpoint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Approve Expense Report Submission","name":"Approve an Expense Report Submission","isWebhook":false,"pointer":"/paths/~1expense_report_submissions~1{id}~1approve/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approve an Expense Report Submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can approve an Expense Report Submission by accessing the approve endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Report Submission objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_report_submissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1expense_report_submissions~1{id}~1approve/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `expenses` (Expense) - Include expense line items with the expense report submission.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `resolutions` (Resolution) - Include the resolutions (approvals, rejections, or cancelations).\n- `user` (User) - Includes user who owns the line items on the submission.\n- `workspace` (Workspace) - Includes workspace to which the submission belongs."}],"pointer":"/paths/~1expense_report_submissions~1{id}~1approve/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1expense_report_submissions~1{id}~1approve/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/expense_report_submissions/{id}/approve","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_report_submissions/{id}/approve","href":"expense-report-submissions/approve expense report submission","openApiOperationId":"Approve Expense Report Submission","summary":"Approve an Expense Report Submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Expense Report Submission has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}},"schemaId":"schema_410"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_report_submissions~1{id}~1approve/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_410","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_report_submissions/{id}/approve"},{"label":"Cancel an Expense Report Submission","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-report-submissions/cancel expense report submission","routeSlug":"/kantata/specification/expense-report-submissions/cancel expense report submission","metadata":{"seo":{"title":"Cancel an Expense Report Submission","description":"You can cancel an Expense Report Submission by accessing the cancel endpoint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Cancel Expense Report Submission","name":"Cancel an Expense Report Submission","isWebhook":false,"pointer":"/paths/~1expense_report_submissions~1{id}~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an Expense Report Submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can cancel an Expense Report Submission by accessing the cancel endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Report Submission objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_report_submissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1expense_report_submissions~1{id}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `expenses` (Expense) - Include expense line items with the expense report submission.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `resolutions` (Resolution) - Include the resolutions (approvals, rejections, or cancelations).\n- `user` (User) - Includes user who owns the line items on the submission.\n- `workspace` (Workspace) - Includes workspace to which the submission belongs."}],"pointer":"/paths/~1expense_report_submissions~1{id}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1expense_report_submissions~1{id}~1cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/expense_report_submissions/{id}/cancel","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_report_submissions/{id}/cancel","href":"expense-report-submissions/cancel expense report submission","openApiOperationId":"Cancel Expense Report Submission","summary":"Cancel an Expense Report Submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Expense Report Submission has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}},"schemaId":"schema_410"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_report_submissions~1{id}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_410","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_report_submissions/{id}/cancel"},{"label":"Reject an Expense Report Submission","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expense-report-submissions/reject expense report submission","routeSlug":"/kantata/specification/expense-report-submissions/reject expense report submission","metadata":{"seo":{"title":"Reject an Expense Report Submission","description":"You can reject an Expense Report Submission by accessing the reject endpoint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Reject Expense Report Submission","name":"Reject an Expense Report Submission","isWebhook":false,"pointer":"/paths/~1expense_report_submissions~1{id}~1reject/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reject an Expense Report Submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can reject an Expense Report Submission by accessing the reject endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense Report Submission objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expense_report_submissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1expense_report_submissions~1{id}~1reject/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `expenses` (Expense) - Include expense line items with the expense report submission.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `resolutions` (Resolution) - Include the resolutions (approvals, rejections, or cancelations).\n- `user` (User) - Includes user who owns the line items on the submission.\n- `workspace` (Workspace) - Includes workspace to which the submission belongs."}],"pointer":"/paths/~1expense_report_submissions~1{id}~1reject/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1expense_report_submissions~1{id}~1reject/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/expense_report_submissions/{id}/reject","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expense_report_submissions/{id}/reject","href":"expense-report-submissions/reject expense report submission","openApiOperationId":"Reject Expense Report Submission","summary":"Reject an Expense Report Submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Expense Report Submission has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}},"schemaId":"schema_410"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expense_report_submissions~1{id}~1reject/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_410","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expense_report_submissions/{id}/reject"}],"content":{"contentType":"group","meta":{"name":"Expense Report Submissions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Expense Report Submissions","showPageActions":true},{"nodeType":"markdoc","content":"Expense report submissions contain a set of expense line items. These expenses must be approved through\nan expense report submission before they can be added to an invoice. All submission expenses must be in the\nsame workspace (project)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/expense_report_submissions","summary":"Fetching a list of Expense Report Submissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/expense-report-submissions/get expense report submissions","deprecated":false},{"title":"/expense_report_submissions","summary":"Creating a new Expense Report Submission","prefix":{"name":"post","color":"post"},"badges":[],"link":"/expense-report-submissions/create expense report submission","deprecated":false},{"title":"/expense_report_submissions/{id}","summary":"Fetching a single Expense Report Submission","prefix":{"name":"get","color":"get"},"badges":[],"link":"/expense-report-submissions/get expense report submission","deprecated":false},{"title":"/expense_report_submissions/{id}/approve","summary":"Approve an Expense Report Submission","prefix":{"name":"put","color":"put"},"badges":[],"link":"/expense-report-submissions/approve expense report submission","deprecated":false},{"title":"/expense_report_submissions/{id}/cancel","summary":"Cancel an Expense Report Submission","prefix":{"name":"put","color":"put"},"badges":[],"link":"/expense-report-submissions/cancel expense report submission","deprecated":false},{"title":"/expense_report_submissions/{id}/reject","summary":"Reject an Expense Report Submission","prefix":{"name":"put","color":"put"},"badges":[],"link":"/expense-report-submissions/reject expense report submission","deprecated":false}]}]}]}]}},{"type":"group","label":"Expenses","link":"/kantata/specification/expenses","routeSlug":"/kantata/specification/expenses","items":[{"label":"Fetching a list of Expenses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expenses/get expenses","routeSlug":"/kantata/specification/expenses/get expenses","metadata":{"seo":{"title":"Fetching a list of Expenses","description":"The expenses endpoint provides a list of every expense that the user making the request is allowed to see—across all projects to which the user belongs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Expenses","name":"Fetching a list of Expenses","isWebhook":false,"pointer":"/paths/~1expenses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Expenses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expenses endpoint provides a list of every expense that the user making the request is allowed to see—"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"across all projects to which the user belongs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain an array of expense objects, sorted by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute in descending order,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expenses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expenses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"approved","in":"query","schemaId":"schema_305","description":"Filter for expenses that are on approved expense reports, or on a workspace that does not require approvals."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_by","in":"query","schemaId":"schema_313"},{"name":"date_expensed_between","in":"query","schemaId":"schema_304","description":"Filter for expenses between the start and end dates in a colon-separated YYYY-MM-DD format. For example, `2013-06-01:2013-08-01`. If a date is not specified, it is interpreted as no start/end date."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"from_archived_workspaces","in":"query","schemaId":"schema_351","description":"Filter for expenses from archived projects."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"in_active_invoice_id","in":"query","schemaId":"schema_313","description":"Limit results to time entries current in the specified active invoice."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `active_submission` (ExpenseReportSubmission) - The active expense report the expense is submitted in. The response will include `active_submission_id`, which references the data in the `expense_report_submissions` top-level key.\n- `expense_budget` (ExpenseBudget) - Retrieves the expense budget the expense is logged to. The response will include `expense_budget_id`, which references the data in the `expense_budgets` top-level key.\n- `expense_category` (ExpenseCategory) - The category associated with the expense. The response will include `expense_category`, which references the data in the `expense_categories` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `receipt` (Attachments::ReceiptAttachment) - Information about receipts associated with this expense. The response will include `receipt_id`, which references the data in the `attachments` top-level key.\n- `recent_submission` (ExpenseReportSubmission) - The most recent expense report the expense was submitted in, including any rejected or cancelled reports. The response will include `recent_submission_id`, which references the data in the `expense_report_submissions` top-level key.\n- `role` (Role) - The role of the user. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `story` (Story) - Linked task. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `user` (User) - The user who created the expense. The response will include `user_id`, which references the data in the `users` top-level key.\n- `vendor` (Vendor) - The party to which the expense is payable. The response will include `vendor_id`, which references the data in the `vendors` top-level key.\n- `workspace` (Workspace) - The project to which this expense belongs. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"invoiced","in":"query","schemaId":"schema_305","description":"Include expenses that have been invoiced."},{"name":"mine","in":"query","schemaId":"schema_305","description":"Filter for expenses created by the user."},{"name":"on_my_account","in":"query","schemaId":"schema_321","description":"Only include expenses that are on internal projects. On my account false will include internal and external expenses."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"optional_fields","in":"query","schemaId":"schema_413","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_414","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `amount:asc`, `amount:desc`, `category:asc`, `category:desc`, `created_at:asc`, `created_at:desc`, `date:asc`, `date:desc`, `notes:asc`, `notes:desc`, `vendor_name:asc`, and `vendor_name:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"reimbursable","in":"query","schemaId":"schema_305","description":"Filter for expenses that are reimbursable based on the provided value."},{"name":"submitted","in":"query","schemaId":"schema_305","description":"Filter for expenses that have been submitted."},{"name":"uninvoiced","in":"query","schemaId":"schema_305","description":"Filter for expenses that have not been invoiced."},{"name":"unsubmitted","in":"query","schemaId":"schema_305","description":"Filter for expenses that have not been submitted."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"with_expense_approvals","in":"query","schemaId":"schema_305"},{"name":"with_expense_report_id","in":"query","schemaId":"schema_313","description":"Filter for expenses associated with the specified expense report ID. If the\n report was canceled or rejected, no result is returned."},{"name":"with_recent_expense_report_ids","in":"query","schemaId":"schema_304","description":"Filter for expenses associated with the specified expense report IDs, including from canceled and rejected reports.\n Give multiple report IDs in a comma separated list.\n\n **Note**: Expenses are only associated with the most recent reports they were submitted in (`recent_submission`).\n If you re-submit an expense from a canceled or rejected report in a new report, the expense will only be returned\n in association with that most recent submission`."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Filter for expenses associated with the specified project ID."}],"pointer":"/paths/~1expenses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/expenses","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"approved","in":"query","schemaId":"schema_305"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"created_by","in":"query","schemaId":"schema_313"},{"name":"date_expensed_between","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"from_archived_workspaces","in":"query","schemaId":"schema_351"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"in_active_invoice_id","in":"query","schemaId":"schema_313"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"invoiced","in":"query","schemaId":"schema_305"},{"name":"mine","in":"query","schemaId":"schema_305"},{"name":"on_my_account","in":"query","schemaId":"schema_321"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_413","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_414"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"reimbursable","in":"query","schemaId":"schema_305"},{"name":"submitted","in":"query","schemaId":"schema_305"},{"name":"uninvoiced","in":"query","schemaId":"schema_305"},{"name":"unsubmitted","in":"query","schemaId":"schema_305"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"with_expense_approvals","in":"query","schemaId":"schema_305"},{"name":"with_expense_report_id","in":"query","schemaId":"schema_313"},{"name":"with_recent_expense_report_ids","in":"query","schemaId":"schema_304"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expenses","href":"expenses/get expenses","openApiOperationId":"Get Expenses","summary":"Fetching a list of Expenses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Expenses have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}},"schemaId":"schema_415"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expenses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expenses"},{"label":"Creating a new Expense","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expenses/create expense","routeSlug":"/kantata/specification/expenses/create expense","metadata":{"seo":{"title":"Creating a new Expense","description":"Creates an expense."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Expense","name":"Creating a new Expense","isWebhook":false,"pointer":"/paths/~1expenses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Expense","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an expense."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"expenses\": [\n {\n \"workspace_id\": 123,\n \"date\": \"2025-01-01\",\n \"expense_category_id\": 456,\n \"category\": \"Travel\",\n \"amount_in_cents\": 20000\n },\n {\n \"workspace_id\": 123,\n \"date\": \"2025-01-01\",\n \"expense_category_id\": 456,\n \"category\": \"Travel\",\n \"amount_in_cents\": 20000\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"expenses\": [\n {\n \"workspace_id\": 123,\n \"date\": \"2025-01-01\",\n \"expense_category_id\": 456,\n \"category\": \"Travel\",\n \"amount_in_cents\": 20000\n },\n {\n \"workspace_id\": 123,\n \"date\": \"2025-01-01\",\n \"expense_category_id\": 456,\n \"category\": \"Travel\",\n \"amount_in_cents\": 20000\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expenses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `active_submission` (ExpenseReportSubmission) - The active expense report the expense is submitted in. The response will include `active_submission_id`, which references the data in the `expense_report_submissions` top-level key.\n- `expense_budget` (ExpenseBudget) - Retrieves the expense budget the expense is logged to. The response will include `expense_budget_id`, which references the data in the `expense_budgets` top-level key.\n- `expense_category` (ExpenseCategory) - The category associated with the expense. The response will include `expense_category`, which references the data in the `expense_categories` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `receipt` (Attachments::ReceiptAttachment) - Information about receipts associated with this expense. The response will include `receipt_id`, which references the data in the `attachments` top-level key.\n- `recent_submission` (ExpenseReportSubmission) - The most recent expense report the expense was submitted in, including any rejected or cancelled reports. The response will include `recent_submission_id`, which references the data in the `expense_report_submissions` top-level key.\n- `role` (Role) - The role of the user. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `story` (Story) - Linked task. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `user` (User) - The user who created the expense. The response will include `user_id`, which references the data in the `users` top-level key.\n- `vendor` (Vendor) - The party to which the expense is payable. The response will include `vendor_id`, which references the data in the `vendors` top-level key.\n- `workspace` (Workspace) - The project to which this expense belongs. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_413","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1expenses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_416"}},"schemaId":"schema_416","pointer":"/paths/~1expenses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/expenses","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_413","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_416"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expenses","href":"expenses/create expense","openApiOperationId":"Create Expense","summary":"Creating a new Expense"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_416","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_416"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Expense has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}},"schemaId":"schema_415"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expenses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expenses"},{"label":"Delete multiple expenses","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expenses/delete expenses","routeSlug":"/kantata/specification/expenses/delete expenses","metadata":{"seo":{"title":"Delete multiple expenses","description":"The IDs of the expenses to delete can be provided in the ids query parameter or via the request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Expenses","name":"Delete multiple expenses","isWebhook":false,"pointer":"/paths/~1expenses/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete multiple expenses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs of the expenses to delete can be provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter or via the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" \"ids\": \"1,2,3\"\n}```\n\nIf any specified expenses cannot be deleted, the entire request will fail and an error message\nwill be returned that specifies which ones could not be deleted and why.\n\n\nThis endpoint returns structured Expense objects.\nAs with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array\nand will be indexed by ID in the `expenses` top-level JSON key.\nPlease see our [Response Format](#section/Response-Format) section for more information.","language":"{"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" \"ids\": \"1,2,3\"\n}```\n\nIf any specified expenses cannot be deleted, the entire request will fail and an error message\nwill be returned that specifies which ones could not be deleted and why.\n\n\nThis endpoint returns structured Expense objects.\nAs with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array\nand will be indexed by ID in the `expenses` top-level JSON key.\nPlease see our [Response Format](#section/Response-Format) section for more information."},"children":[]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ids","in":"query","schemaId":"schema_304","description":"A comma-separated list of IDs of expenses. You can provide up to 100 IDs. The IDs can be\nprovided in this query parameter or via the request body."}],"pointer":"/paths/~1expenses/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/expenses","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"ids","in":"query","required":false,"schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expenses","href":"expenses/delete expenses","openApiOperationId":"Delete Expenses","summary":"Delete multiple expenses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Expense has been deleted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_417"}},"schemaId":"schema_417"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expenses/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_417","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_417"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expenses"},{"label":"Fetching a single Expense","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expenses/get expense","routeSlug":"/kantata/specification/expenses/get expense","metadata":{"seo":{"title":"Fetching a single Expense","description":"You can request either GET /api/v1/expenses.json?only=5 orGET /api/v1/expenses/5.json. In both cases, default filters will be applied. Unless youprovide the from_archived_workspaces:true filter you won't receive expenses from archived projects,and will get a 404 status on the \"show\" route."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Expense","name":"Fetching a single Expense","isWebhook":false,"pointer":"/paths/~1expenses~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Expense","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/expenses.json?only=5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/expenses/5.json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In both cases, default filters will be applied. Unless you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from_archived_workspaces:true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter you won't receive expenses from archived projects,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will get a 404 status on the \"show\" route."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expenses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1expenses~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `active_submission` (ExpenseReportSubmission) - The active expense report the expense is submitted in. The response will include `active_submission_id`, which references the data in the `expense_report_submissions` top-level key.\n- `expense_budget` (ExpenseBudget) - Retrieves the expense budget the expense is logged to. The response will include `expense_budget_id`, which references the data in the `expense_budgets` top-level key.\n- `expense_category` (ExpenseCategory) - The category associated with the expense. The response will include `expense_category`, which references the data in the `expense_categories` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `receipt` (Attachments::ReceiptAttachment) - Information about receipts associated with this expense. The response will include `receipt_id`, which references the data in the `attachments` top-level key.\n- `recent_submission` (ExpenseReportSubmission) - The most recent expense report the expense was submitted in, including any rejected or cancelled reports. The response will include `recent_submission_id`, which references the data in the `expense_report_submissions` top-level key.\n- `role` (Role) - The role of the user. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `story` (Story) - Linked task. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `user` (User) - The user who created the expense. The response will include `user_id`, which references the data in the `users` top-level key.\n- `vendor` (Vendor) - The party to which the expense is payable. The response will include `vendor_id`, which references the data in the `vendors` top-level key.\n- `workspace` (Workspace) - The project to which this expense belongs. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_413","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1expenses~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/expenses/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_413","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expenses/{id}","href":"expenses/get expense","openApiOperationId":"Get Expense","summary":"Fetching a single Expense"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Expense has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}},"schemaId":"schema_415"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expenses~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expenses/{id}"},{"label":"Updating an existing Expense","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expenses/update expense","routeSlug":"/kantata/specification/expenses/update expense","metadata":{"seo":{"title":"Updating an existing Expense","description":"An expense that has already been created can be updated with an HTTP PUT request. Any required or optionalattribute, with the exception of workspace_id, can be changed in an update."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Expense","name":"Updating an existing Expense","isWebhook":false,"pointer":"/paths/~1expenses~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Expense","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An expense that has already been created can be updated with an HTTP PUT request. Any required or optional"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attribute, with the exception of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", can be changed in an update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Expense objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expenses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1expenses~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `active_submission` (ExpenseReportSubmission) - The active expense report the expense is submitted in. The response will include `active_submission_id`, which references the data in the `expense_report_submissions` top-level key.\n- `expense_budget` (ExpenseBudget) - Retrieves the expense budget the expense is logged to. The response will include `expense_budget_id`, which references the data in the `expense_budgets` top-level key.\n- `expense_category` (ExpenseCategory) - The category associated with the expense. The response will include `expense_category`, which references the data in the `expense_categories` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `receipt` (Attachments::ReceiptAttachment) - Information about receipts associated with this expense. The response will include `receipt_id`, which references the data in the `attachments` top-level key.\n- `recent_submission` (ExpenseReportSubmission) - The most recent expense report the expense was submitted in, including any rejected or cancelled reports. The response will include `recent_submission_id`, which references the data in the `expense_report_submissions` top-level key.\n- `role` (Role) - The role of the user. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `story` (Story) - Linked task. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `user` (User) - The user who created the expense. The response will include `user_id`, which references the data in the `users` top-level key.\n- `vendor` (Vendor) - The party to which the expense is payable. The response will include `vendor_id`, which references the data in the `vendors` top-level key.\n- `workspace` (Workspace) - The project to which this expense belongs. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_413","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1expenses~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_418"}},"schemaId":"schema_418","pointer":"/paths/~1expenses~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/expenses/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_413","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_418"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/expenses/{id}","href":"expenses/update expense","openApiOperationId":"Update Expense","summary":"Updating an existing Expense"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_418","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_418"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Expense has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}},"schemaId":"schema_415"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expenses~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expenses/{id}"},{"label":"Deleting an existing Expense","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/expenses/delete expense","routeSlug":"/kantata/specification/expenses/delete expense","metadata":{"seo":{"title":"Deleting an existing Expense","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Expense","name":"Deleting an existing Expense","isWebhook":false,"pointer":"/paths/~1expenses~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Expense","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1expenses~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/expenses/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/expenses/{id}","href":"expenses/delete expense","openApiOperationId":"Delete Expense","summary":"Deleting an existing Expense"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Expense has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1expenses~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/expenses/{id}"}],"content":{"contentType":"group","meta":{"name":"Expenses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Expenses","showPageActions":true},{"nodeType":"markdoc","content":"Expenses are defined as costs incurred as part of a project, but not related to time. Once created, expenses can\nbe included in generated invoices."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/expenses","summary":"Fetching a list of Expenses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/expenses/get expenses","deprecated":false},{"title":"/expenses","summary":"Creating a new Expense","prefix":{"name":"post","color":"post"},"badges":[],"link":"/expenses/create expense","deprecated":false},{"title":"/expenses","summary":"Delete multiple expenses","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/expenses/delete expenses","deprecated":false},{"title":"/expenses/{id}","summary":"Fetching a single Expense","prefix":{"name":"get","color":"get"},"badges":[],"link":"/expenses/get expense","deprecated":false},{"title":"/expenses/{id}","summary":"Updating an existing Expense","prefix":{"name":"put","color":"put"},"badges":[],"link":"/expenses/update expense","deprecated":false},{"title":"/expenses/{id}","summary":"Deleting an existing Expense","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/expenses/delete expense","deprecated":false}]}]}]}]}},{"type":"group","label":"Vendors","link":"/kantata/specification/vendors","routeSlug":"/kantata/specification/vendors","items":[{"label":"Fetching a list of Vendors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/vendors/get vendors","routeSlug":"/kantata/specification/vendors/get vendors","metadata":{"seo":{"title":"Fetching a list of Vendors","description":"This endpoint returns structured Vendor objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the vendors top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Vendors","name":"Fetching a list of Vendors","isWebhook":false,"pointer":"/paths/~1vendors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Vendors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Vendor objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vendors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"archived","in":"query","schemaId":"schema_305","description":"If *True*, returns all archived vendors and false returns all active vendors."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_343","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `alphabetical:asc` and `alphabetical:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1vendors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/vendors","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"archived","in":"query","schemaId":"schema_305"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_343"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/vendors","href":"vendors/get vendors","openApiOperationId":"Get Vendors","summary":"Fetching a list of Vendors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Vendors have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_419"}},"schemaId":"schema_419"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1vendors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_419","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_419"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/vendors"},{"label":"Creating a new Vendor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/vendors/create vendor","routeSlug":"/kantata/specification/vendors/create vendor","metadata":{"seo":{"title":"Creating a new Vendor","description":"This endpoint returns structured Vendor objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the vendors top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Vendor","name":"Creating a new Vendor","isWebhook":false,"pointer":"/paths/~1vendors/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Vendor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Vendor objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vendors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."}],"pointer":"/paths/~1vendors/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_420"}},"schemaId":"schema_420","pointer":"/paths/~1vendors/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/vendors","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_420"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/vendors","href":"vendors/create vendor","openApiOperationId":"Create Vendor","summary":"Creating a new Vendor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_420","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_420"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Vendor has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_419"}},"schemaId":"schema_419"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1vendors/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_419","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_419"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/vendors"},{"label":"Updating an existing Vendor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/vendors/update vendor","routeSlug":"/kantata/specification/vendors/update vendor","metadata":{"seo":{"title":"Updating an existing Vendor","description":"This endpoint returns structured Vendor objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the vendors top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Vendor","name":"Updating an existing Vendor","isWebhook":false,"pointer":"/paths/~1vendors~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Vendor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Vendor objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vendors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1vendors~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."}],"pointer":"/paths/~1vendors~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_421"}},"schemaId":"schema_421","pointer":"/paths/~1vendors~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/vendors/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_421"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/vendors/{id}","href":"vendors/update vendor","openApiOperationId":"Update Vendor","summary":"Updating an existing Vendor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_421","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_421"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Vendor has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_419"}},"schemaId":"schema_419"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1vendors~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_419","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_419"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/vendors/{id}"},{"label":"Deleting an existing Vendor","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/vendors/delete vendor","routeSlug":"/kantata/specification/vendors/delete vendor","metadata":{"seo":{"title":"Deleting an existing Vendor","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Vendor","name":"Deleting an existing Vendor","isWebhook":false,"pointer":"/paths/~1vendors~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Vendor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1vendors~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/vendors/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/vendors/{id}","href":"vendors/delete vendor","openApiOperationId":"Delete Vendor","summary":"Deleting an existing Vendor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Vendor has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1vendors~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/vendors/{id}"}],"content":{"contentType":"group","meta":{"name":"Vendors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Vendors","showPageActions":true},{"nodeType":"markdoc","content":"A Vendor is an entity to which an expense can be paid."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/vendors","summary":"Fetching a list of Vendors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/vendors/get vendors","deprecated":false},{"title":"/vendors","summary":"Creating a new Vendor","prefix":{"name":"post","color":"post"},"badges":[],"link":"/vendors/create vendor","deprecated":false},{"title":"/vendors/{id}","summary":"Updating an existing Vendor","prefix":{"name":"put","color":"put"},"badges":[],"link":"/vendors/update vendor","deprecated":false},{"title":"/vendors/{id}","summary":"Deleting an existing Vendor","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/vendors/delete vendor","deprecated":false}]}]}]}]}},{"type":"separator","label":"External References","content":null},{"type":"group","label":"External References","link":"/kantata/specification/external-references","routeSlug":"/kantata/specification/external-references","items":[{"label":"Fetches all external references on a user's account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/external-references/get external references","routeSlug":"/kantata/specification/external-references/get external references","metadata":{"seo":{"title":"Fetches all external references on a user's account","description":"Returns external references, for objects of particular types, that are synced with thethird-party systems."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get External References","name":"Fetches all external references on a user's account","isWebhook":false,"pointer":"/paths/~1external_references/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetches all external references on a user's account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns external references, for objects of particular types, that are synced with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"third-party systems."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured External Reference objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_references"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subject_type","in":"query","schemaId":"schema_304","description":"The type of the Kantata OX object that has the external reference. One of\n`Assignment`, `BillingMilestone`, `CustomField`, `CustomFieldChoice`, `CustomFieldSet`, `CustomFieldValue`, `Estimate`, `EstimateScenario`, `EstimateScenarioResource`, `Expense`, `ExpenseBudget`, `Invoice`, `Participation`, `Post`, `RateCard`, `Role`, `Skill`, `StatusReport`, `Story`, `StoryAllocationDay`, `Submission`, `SurveyAnswer`, `SurveyQuestion`, `SurveyResponse`, `SurveyTemplate`, `TimeEntry`, `TimeOffEntry`, `User`, `Vendor`, `Workspace`, `WorkspaceAllocation`, `WorkspaceGroup`, or `WorkspaceResource`.","required":true},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_message","in":"query","schemaId":"schema_304","description":"Only include external references with the specified external message."},{"name":"external_status","in":"query","schemaId":"schema_304","description":"The status of the external object in the external system."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `subject` (polymorphic) - The item with which the external reference is associated."},{"name":"last_synced_after","in":"query","schemaId":"schema_303","description":"Filter for records last synced after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"last_synced_before","in":"query","schemaId":"schema_303","description":"Filter for records last synced before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_422","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `last_synced_at:asc`, and `last_synced_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"service_model","in":"query","schemaId":"schema_304","description":"The type of the external object."},{"name":"service_model_ref","in":"query","schemaId":"schema_304","description":"The object ID of an external object."},{"name":"service_name","in":"query","schemaId":"schema_304","description":"The provider name of the integration."},{"name":"status","in":"query","schemaId":"schema_304","description":"The status of the integration. Options are 'pending', 'successful', or 'failed'."},{"name":"subject_id","in":"query","schemaId":"schema_313","description":"The ID of the Kantata OX object that has the external reference."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1external_references/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/external_references","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"subject_type","in":"query","required":true,"schemaId":"schema_304"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_message","in":"query","schemaId":"schema_304"},{"name":"external_status","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"last_synced_after","in":"query","schemaId":"schema_303"},{"name":"last_synced_before","in":"query","schemaId":"schema_303"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_422"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"service_model","in":"query","schemaId":"schema_304"},{"name":"service_model_ref","in":"query","schemaId":"schema_304"},{"name":"service_name","in":"query","schemaId":"schema_304"},{"name":"status","in":"query","schemaId":"schema_304"},{"name":"subject_id","in":"query","required":false,"schemaId":"schema_313"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/external_references","href":"external-references/get external references","openApiOperationId":"Get External References","summary":"Fetches all external references on a user's account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of External References have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}},"schemaId":"schema_423"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1external_references/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_423","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/external_references"},{"label":"Create or update an external reference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/external-references/create or update external reference","routeSlug":"/kantata/specification/external-references/create or update external reference","metadata":{"seo":{"title":"Create or update an external reference","description":"This endpoint returns structured External Reference objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the external_references top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Or Update External Reference","name":"Create or update an external reference","isWebhook":false,"pointer":"/paths/~1external_references~1create_or_update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update an external reference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured External Reference objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_references"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `subject` (polymorphic) - The item with which the external reference is associated."}],"pointer":"/paths/~1external_references~1create_or_update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_424"}},"schemaId":"schema_424","pointer":"/paths/~1external_references~1create_or_update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/external_references/create_or_update","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_424"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/external_references/create_or_update","href":"external-references/create or update external reference","openApiOperationId":"Create Or Update External Reference","summary":"Create or update an external reference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_424","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_424"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"External Reference has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}},"schemaId":"schema_423"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1external_references~1create_or_update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_423","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/external_references/create_or_update"},{"label":"Deleting an existing External Reference","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/external-references/delete external reference","routeSlug":"/kantata/specification/external-references/delete external reference","metadata":{"seo":{"title":"Deleting an existing External Reference","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete External Reference","name":"Deleting an existing External Reference","isWebhook":false,"pointer":"/paths/~1external_references~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing External Reference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1external_references~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/external_references/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/external_references/{id}","href":"external-references/delete external reference","openApiOperationId":"Delete External Reference","summary":"Deleting an existing External Reference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"External Reference has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1external_references~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/external_references/{id}"}],"content":{"contentType":"group","meta":{"name":"External References"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External References","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External References allows users see which objects (one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Assignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillingMilestone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomFieldChoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomFieldSet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomFieldValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Estimate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EstimateScenario"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EstimateScenarioResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expense"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExpenseBudget"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Participation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Post"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RateCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StatusReport"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Story"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StoryAllocationDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Submission"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SurveyAnswer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SurveyQuestion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SurveyResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SurveyTemplate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeEntry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeOffEntry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Vendor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Workspace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WorkspaceAllocation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WorkspaceGroup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WorkspaceResource"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are synced with third party systems. This allows you to view the sync status of items in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"addition to the integration specifics for a synced object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Objects that are synced with a third party system have external integration"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attributes that include the corresponding ID of the third-party object with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which it is synced, a link that allows you to view the object in the third"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"party system, the status of the external object in the external system,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the status of the sync, and a link to exceptions."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/external_references","summary":"Fetches all external references on a user's account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/external-references/get external references","deprecated":false},{"title":"/external_references/create_or_update","summary":"Create or update an external reference","prefix":{"name":"post","color":"post"},"badges":[],"link":"/external-references/create or update external reference","deprecated":false},{"title":"/external_references/{id}","summary":"Deleting an existing External Reference","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/external-references/delete external reference","deprecated":false}]}]}]}]}},{"type":"separator","label":"Financials","content":null},{"type":"group","label":"Billing Milestones","link":"/kantata/specification/billing-milestones","routeSlug":"/kantata/specification/billing-milestones","items":[{"label":"Fetching a list of Billing Milestones","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/billing-milestones/get billing milestones","routeSlug":"/kantata/specification/billing-milestones/get billing milestones","metadata":{"seo":{"title":"Fetching a list of Billing Milestones","description":"Gets a list of billing milestones."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Billing Milestones","name":"Fetching a list of Billing Milestones","isWebhook":false,"pointer":"/paths/~1billing_milestones/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Billing Milestones","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a list of billing milestones."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Billing Milestones objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_milestones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_between","in":"query","schemaId":"schema_304","description":"Filter by a range of invoice dates. Format as `YYYY-MM-DD:YYYY-MM-DD`. The filter is inclusive."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `invoices` (Invoice) - Retrieves the invoices that the billing milestones are on. The response will include `invoice_ids`, which references the data in the `invoices` top-level key.\n- `story` (Story) - Retrieves the task associated with the billing milestone. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `workspace` (Workspace) - Retrieves the project that the billing milestone is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"story_ids","in":"query","schemaId":"schema_304","description":"Filter for billing milestones associated to specific tasks. Provide a comma-separated list of task IDs. For example, `10,20`."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_ids","in":"query","schemaId":"schema_304","description":"Filter by the workspace. Provide a comma-separated list of workspace IDs. For example, `10,20`."}],"pointer":"/paths/~1billing_milestones/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billing_milestones","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"date_between","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"story_ids","in":"query","schemaId":"schema_304"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_ids","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/billing_milestones","href":"billing-milestones/get billing milestones","openApiOperationId":"Get Billing Milestones","summary":"Fetching a list of Billing Milestones"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Billing Milestones have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}},"schemaId":"schema_425"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1billing_milestones/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/billing_milestones"},{"label":"Creating one or many Billing Milestones","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/billing-milestones/create billing milestone","routeSlug":"/kantata/specification/billing-milestones/create billing milestone","metadata":{"seo":{"title":"Creating one or many Billing Milestones","description":"Add a billing milestone to your Billing Schedule. Up to 100 billing milestones can be created in one request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Billing Milestone","name":"Creating one or many Billing Milestones","isWebhook":false,"pointer":"/paths/~1billing_milestones/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating one or many Billing Milestones","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a billing milestone to your Billing Schedule. Up to 100 billing milestones can be created in one request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Billing Milestones objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_milestones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `invoices` (Invoice) - Retrieves the invoices that the billing milestones are on. The response will include `invoice_ids`, which references the data in the `invoices` top-level key.\n- `story` (Story) - Retrieves the task associated with the billing milestone. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `workspace` (Workspace) - Retrieves the project that the billing milestone is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."}],"pointer":"/paths/~1billing_milestones/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_426"}},"schemaId":"schema_426","pointer":"/paths/~1billing_milestones/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billing_milestones","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_426"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/billing_milestones","href":"billing-milestones/create billing milestone","openApiOperationId":"Create Billing Milestone","summary":"Creating one or many Billing Milestones"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_426","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_426"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Billing Milestones has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}},"schemaId":"schema_425"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1billing_milestones/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/billing_milestones"},{"label":"Fetching a single Billing Milestone","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/billing-milestones/get billing milestone","routeSlug":"/kantata/specification/billing-milestones/get billing milestone","metadata":{"seo":{"title":"Fetching a single Billing Milestone","description":"Gets a single billing milestone."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Billing Milestone","name":"Fetching a single Billing Milestone","isWebhook":false,"pointer":"/paths/~1billing_milestones~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Billing Milestone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a single billing milestone."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Billing Milestones objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_milestones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1billing_milestones~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `invoices` (Invoice) - Retrieves the invoices that the billing milestones are on. The response will include `invoice_ids`, which references the data in the `invoices` top-level key.\n- `story` (Story) - Retrieves the task associated with the billing milestone. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `workspace` (Workspace) - Retrieves the project that the billing milestone is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."}],"pointer":"/paths/~1billing_milestones~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billing_milestones/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/billing_milestones/{id}","href":"billing-milestones/get billing milestone","openApiOperationId":"Get Billing Milestone","summary":"Fetching a single Billing Milestone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Billing Milestones has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}},"schemaId":"schema_425"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1billing_milestones~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/billing_milestones/{id}"},{"label":"Updating an existing Billing Milestone","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/billing-milestones/update billing milestone","routeSlug":"/kantata/specification/billing-milestones/update billing milestone","metadata":{"seo":{"title":"Updating an existing Billing Milestone","description":"Edit information for a billing milestone in your Billing Schedule. You can only edit billing milestones that have not been invoiced."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Billing Milestone","name":"Updating an existing Billing Milestone","isWebhook":false,"pointer":"/paths/~1billing_milestones~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Billing Milestone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit information for a billing milestone in your Billing Schedule. You can only edit billing milestones that have not been invoiced."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Billing Milestones objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_milestones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1billing_milestones~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `invoices` (Invoice) - Retrieves the invoices that the billing milestones are on. The response will include `invoice_ids`, which references the data in the `invoices` top-level key.\n- `story` (Story) - Retrieves the task associated with the billing milestone. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `workspace` (Workspace) - Retrieves the project that the billing milestone is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."}],"pointer":"/paths/~1billing_milestones~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_427"}},"schemaId":"schema_427","pointer":"/paths/~1billing_milestones~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/billing_milestones/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_427"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/billing_milestones/{id}","href":"billing-milestones/update billing milestone","openApiOperationId":"Update Billing Milestone","summary":"Updating an existing Billing Milestone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_427","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_427"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Billing Milestones has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}},"schemaId":"schema_425"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1billing_milestones~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/billing_milestones/{id}"},{"label":"Deleting an existing Billing Milestones","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/billing-milestones/delete billing milestone","routeSlug":"/kantata/specification/billing-milestones/delete billing milestone","metadata":{"seo":{"title":"Deleting an existing Billing Milestones","description":"Delete a billing milestone in your Billing Schedule. You can only delete billing milestones that have not been invoiced."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Billing Milestone","name":"Deleting an existing Billing Milestones","isWebhook":false,"pointer":"/paths/~1billing_milestones~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Billing Milestones","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a billing milestone in your Billing Schedule. You can only delete billing milestones that have not been invoiced."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1billing_milestones~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/billing_milestones/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/billing_milestones/{id}","href":"billing-milestones/delete billing milestone","openApiOperationId":"Delete Billing Milestone","summary":"Deleting an existing Billing Milestones"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Billing Milestones has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1billing_milestones~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/billing_milestones/{id}"}],"content":{"contentType":"group","meta":{"name":"Billing Milestones"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing Milestones","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing milestones allow you to set up billable items in a project that are separate from the Task Tracker work and have invoicing rules."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A set of billing milestones in a project is known as the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/35123275585947"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/billing_milestones","summary":"Fetching a list of Billing Milestones","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-milestones/get billing milestones","deprecated":false},{"title":"/billing_milestones","summary":"Creating one or many Billing Milestones","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-milestones/create billing milestone","deprecated":false},{"title":"/billing_milestones/{id}","summary":"Fetching a single Billing Milestone","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-milestones/get billing milestone","deprecated":false},{"title":"/billing_milestones/{id}","summary":"Updating an existing Billing Milestone","prefix":{"name":"put","color":"put"},"badges":[],"link":"/billing-milestones/update billing milestone","deprecated":false},{"title":"/billing_milestones/{id}","summary":"Deleting an existing Billing Milestones","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/billing-milestones/delete billing milestone","deprecated":false}]}]}]}]}},{"type":"group","label":"Revenue Recognition Methods","link":"/kantata/specification/revenue-recognition-methods","routeSlug":"/kantata/specification/revenue-recognition-methods","items":[{"label":"Fetching a list of Revenue Recognition Methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/revenue-recognition-methods/get revenue recognition methods","routeSlug":"/kantata/specification/revenue-recognition-methods/get revenue recognition methods","metadata":{"seo":{"title":"Fetching a list of Revenue Recognition Methods","description":"Gets a list of revenue recognition methods that are available to apply to projects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Revenue Recognition Methods","name":"Fetching a list of Revenue Recognition Methods","isWebhook":false,"pointer":"/paths/~1revenue_recognition_methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Revenue Recognition Methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a list of revenue recognition methods that are available to apply to projects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Revenue Recognition Method objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenue_recognition_methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"active","in":"query","schemaId":"schema_304","description":"Return only active (`true`) or inactive (`false`) methods."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to get one or more methods directly by ID. The ID is in the following format: `id:revenue_recognition_method_type`. For example, `42:percent_complete`. Multiple IDs can be supplied in a comma separated list, like `GET /api/v1/revenue_recognition_methods?only=42:percent_complete,43:time_and_materials`."}],"pointer":"/paths/~1revenue_recognition_methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue_recognition_methods","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"active","in":"query","required":false,"schemaId":"schema_304"},{"name":"only","in":"query","required":false,"schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/revenue_recognition_methods","href":"revenue-recognition-methods/get revenue recognition methods","openApiOperationId":"Get Revenue Recognition Methods","summary":"Fetching a list of Revenue Recognition Methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Revenue Recognition Methods have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}},"schemaId":"schema_428"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1revenue_recognition_methods/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_428","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/revenue_recognition_methods"}],"content":{"contentType":"group","meta":{"name":"Revenue Recognition Methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revenue Recognition Methods","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue recognition methods determine how revenue is recognized. Methods are configured at the account level, then each project can have an available method applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only when the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/38986877019803-Revenue-Management-Early-Access"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"early access feature Revenue Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is activated."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue_recognition_methods","summary":"Fetching a list of Revenue Recognition Methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-recognition-methods/get revenue recognition methods","deprecated":false}]}]}]}]}},{"type":"separator","label":"Foreign Exchange","content":null},{"type":"group","label":"Exchange Tables","link":"/kantata/specification/exchange-tables","routeSlug":"/kantata/specification/exchange-tables","items":[{"label":"Fetching a list of Exchange Tables","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/exchange-tables/get exchange tables","routeSlug":"/kantata/specification/exchange-tables/get exchange tables","metadata":{"seo":{"title":"Fetching a list of Exchange Tables","description":"Returns a list of exchange tables associated with your account, and their default settings details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Exchange Tables","name":"Fetching a list of Exchange Tables","isWebhook":false,"pointer":"/paths/~1foreign_exchange~1exchange_tables/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Exchange Tables","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of exchange tables associated with your account, and their default settings details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/foreign_exchange/exchange_tables","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/foreign_exchange/exchange_tables","href":"exchange-tables/get exchange tables","openApiOperationId":"Get Exchange Tables","summary":"Fetching a list of Exchange Tables"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Exchange Tables have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1foreign_exchange~1exchange_tables/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/foreign_exchange/exchange_tables"},{"label":"Creating a new Exchange Table","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/exchange-tables/create exchange table","routeSlug":"/kantata/specification/exchange-tables/create exchange table","metadata":{"seo":{"title":"Creating a new Exchange Table","description":"Creates a new exchange table."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Exchange Table","name":"Creating a new Exchange Table","isWebhook":false,"pointer":"/paths/~1foreign_exchange~1exchange_tables/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Exchange Table","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new exchange table."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_304","description":"Give a name for your new exchange table.","required":true},{"name":"account_default","in":"query","schemaId":"schema_305","description":"If `true`, sets the exchange table to be the default\n for currency conversions across your entire account.\n This includes currency conversions in Insights reports, unless you set a different table\n as the `insights_account_default`."},{"name":"insights_account_default","in":"query","schemaId":"schema_305","description":"If `true`, sets the exchange table to be\n the default for currency conversions in Insights reports.\n The `insights_account_default` exchange table must have 400 or fewer currency pairs\n in order for exchange rates information to display in Insights reports."}],"pointer":"/paths/~1foreign_exchange~1exchange_tables/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/foreign_exchange/exchange_tables","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":true,"schemaId":"schema_304"},{"name":"account_default","in":"query","required":false,"schemaId":"schema_305"},{"name":"insights_account_default","in":"query","required":false,"schemaId":"schema_305"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/foreign_exchange/exchange_tables","href":"exchange-tables/create exchange table","openApiOperationId":"Create Exchange Table","summary":"Creating a new Exchange Table"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Exchange Table has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1foreign_exchange~1exchange_tables/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/foreign_exchange/exchange_tables"},{"label":"Fetching a single Exchange Table","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/exchange-tables/get exchange table","routeSlug":"/kantata/specification/exchange-tables/get exchange table","metadata":{"seo":{"title":"Fetching a single Exchange Table","description":"Returns default settings details for a specified exchange table."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Exchange Table","name":"Fetching a single Exchange Table","isWebhook":false,"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Exchange Table","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns default settings details for a specified exchange table."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/foreign_exchange/exchange_tables/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/foreign_exchange/exchange_tables/{id}","href":"exchange-tables/get exchange table","openApiOperationId":"Get Exchange Table","summary":"Fetching a single Exchange Table"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Exchange Table has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}},"schemaId":"schema_430"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_430","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/foreign_exchange/exchange_tables/{id}"},{"label":"Updating an existing Exchange Table","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/exchange-tables/update exchange table","routeSlug":"/kantata/specification/exchange-tables/update exchange table","metadata":{"seo":{"title":"Updating an existing Exchange Table","description":"Updates the name and/or default settings for a specified exchange table."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Exchange Table","name":"Updating an existing Exchange Table","isWebhook":false,"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Exchange Table","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the name and/or default settings for a specified exchange table."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account_default","in":"query","schemaId":"schema_305","description":"If `true`, sets the exchange table to be the default\n for currency conversions across your entire account.\n This includes currency conversions in Insights reports, unless you set a different table\n as the `insights_account_default`."},{"name":"insights_account_default","in":"query","schemaId":"schema_305","description":"If `true`, sets the exchange table to be\n the default for currency conversions in Insights reports.\n The `insights_account_default` exchange table must have 400 or fewer currency pairs\n in order for exchange rates information to display in Insights reports."},{"name":"name","in":"query","schemaId":"schema_304","description":"Update the name of the exchange table."}],"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/foreign_exchange/exchange_tables/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"account_default","in":"query","required":false,"schemaId":"schema_305"},{"name":"insights_account_default","in":"query","required":false,"schemaId":"schema_305"},{"name":"name","in":"query","required":false,"schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/foreign_exchange/exchange_tables/{id}","href":"exchange-tables/update exchange table","openApiOperationId":"Update Exchange Table","summary":"Updating an existing Exchange Table"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Exchange Table has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/foreign_exchange/exchange_tables/{id}"},{"label":"Import Exchange Rates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/exchange-tables/import exchange tables","routeSlug":"/kantata/specification/exchange-tables/import exchange tables","metadata":{"seo":{"title":"Import Exchange Rates","description":"Add or update exchange rates for a specified exchange table by importing rates as a .csv file, or in a JSON array of hashes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Import Exchange Tables","name":"Import Exchange Rates","isWebhook":false,"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}~1rates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import Exchange Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add or update exchange rates for a specified exchange table by importing rates as a .csv file, or in a JSON array of hashes."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}~1rates/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"csv_file","in":"query","schemaId":"schema_304","description":"A CSV file with the following headers: **Source Currency**, **Target Currency**, **Exchange Rate**, and **Effective Date**.\n\nFor more details on how to format your CSV file, please see the [Knowledge Base](https://mavenlink.zendesk.com/hc/en-us/articles/360047982574).\n\nAlternatively, you can provide exchanges rates via the `exchange_rates` parameter. If both `csv_file` and `exchange_rates` are provided, `csv_file` will override `exchange_rates`.","required":true}],"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}~1rates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_431"}},"schemaId":"schema_431","pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}~1rates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/foreign_exchange/exchange_tables/{id}/rates","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"csv_file","in":"query","required":true,"schemaId":"schema_304","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_431"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/foreign_exchange/exchange_tables/{id}/rates","href":"exchange-tables/import exchange tables","openApiOperationId":"Import Exchange Tables","summary":"Import Exchange Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_431","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_431"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Exchange Table has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_432"}},"schemaId":"schema_432"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}~1rates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_432","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_432"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/foreign_exchange/exchange_tables/{id}/rates"},{"label":"Fetching a list of Exchange Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/exchange-tables/get exchange rates","routeSlug":"/kantata/specification/exchange-tables/get exchange rates","metadata":{"seo":{"title":"Fetching a list of Exchange Rates","description":"Returns all current exchange rates for a specified exchange table, unless filter parameters have been applied.."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Exchange Rates","name":"Fetching a list of Exchange Rates","isWebhook":false,"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}~1rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Exchange Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all current exchange rates for a specified exchange table, unless filter parameters have been applied.."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}~1rates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date","in":"query","schemaId":"schema_368","description":"Filter for rates by the date the exchange rate takes effect. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"page","in":"query","schemaId":"schema_313"},{"name":"per_page","in":"query","schemaId":"schema_313"},{"name":"source_currency","in":"query","schemaId":"schema_304","description":"Filter for rates with the specified source currency (in [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473-Supported-Currency-ISO-Codes) format). The source currency is the currency you are converting from."},{"name":"target_currency","in":"query","schemaId":"schema_304","description":"Filter for rates with the specified target currency (in [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473-Supported-Currency-ISO-Codes) format). The target currency is the currency you are converting to."}],"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}~1rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/foreign_exchange/exchange_tables/{id}/rates","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"date","in":"query","required":false,"schemaId":"schema_368"},{"name":"page","in":"query","required":false,"schemaId":"schema_313"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_313"},{"name":"source_currency","in":"query","required":false,"schemaId":"schema_304"},{"name":"target_currency","in":"query","required":false,"schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/foreign_exchange/exchange_tables/{id}/rates","href":"exchange-tables/get exchange rates","openApiOperationId":"Get Exchange Rates","summary":"Fetching a list of Exchange Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Exchange Tables have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_432"}},"schemaId":"schema_432"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1foreign_exchange~1exchange_tables~1{id}~1rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_432","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_432"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/foreign_exchange/exchange_tables/{id}/rates"}],"content":{"contentType":"group","meta":{"name":"Exchange Tables"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange Tables","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows you to view or edit foreign currency exchange rates, depending on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/360047485453"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Foreign Exchange Access Group Set"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permissions. If you are not a member of an Access Group with Foreign Exchange (FX) permissions, an account administrator will need to add you to one."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are an account admin that needs FX permissions, you can add yourself to an Access Group with the FX permissions you require."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/foreign_exchange/exchange_tables","summary":"Fetching a list of Exchange Tables","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exchange-tables/get exchange tables","deprecated":false},{"title":"/foreign_exchange/exchange_tables","summary":"Creating a new Exchange Table","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exchange-tables/create exchange table","deprecated":false},{"title":"/foreign_exchange/exchange_tables/{id}","summary":"Fetching a single Exchange Table","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exchange-tables/get exchange table","deprecated":false},{"title":"/foreign_exchange/exchange_tables/{id}","summary":"Updating an existing Exchange Table","prefix":{"name":"put","color":"put"},"badges":[],"link":"/exchange-tables/update exchange table","deprecated":false},{"title":"/foreign_exchange/exchange_tables/{id}/rates","summary":"Import Exchange Rates","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exchange-tables/import exchange tables","deprecated":false},{"title":"/foreign_exchange/exchange_tables/{id}/rates","summary":"Fetching a list of Exchange Rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exchange-tables/get exchange rates","deprecated":false}]}]}]}]}},{"type":"separator","label":"Insights & Analytics","content":null},{"type":"group","label":"Insights Access Group Memberships","link":"/kantata/specification/insights-access-group-memberships","routeSlug":"/kantata/specification/insights-access-group-memberships","items":[{"label":"Fetching a list of Insights Access Group Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-access-group-memberships/get insights access group memberships","routeSlug":"/kantata/specification/insights-access-group-memberships/get insights access group memberships","metadata":{"seo":{"title":"Fetching a list of Insights Access Group Memberships","description":"This endpoint returns structured Insights Access Group Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the insights_access_group_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Insights Access Group Memberships","name":"Fetching a list of Insights Access Group Memberships","isWebhook":false,"pointer":"/paths/~1insights_access_group_memberships/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Insights Access Group Memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Insights Access Group Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insights_access_group_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"by_access_group_id","in":"query","schemaId":"schema_313","description":"Return only memberships associated with a specified Insights Access Group ID."},{"name":"by_user_name","in":"query","schemaId":"schema_304","description":"Return only memberships associated with a specified user name."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - References the associated user."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"optional_fields","in":"query","schemaId":"schema_433","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"user_ids","in":"query","schemaId":"schema_352","description":"Return only memberships associated with the specified user IDs."}],"pointer":"/paths/~1insights_access_group_memberships/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/insights_access_group_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"by_access_group_id","in":"query","schemaId":"schema_313"},{"name":"by_user_name","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_433","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"user_ids","in":"query","schemaId":"schema_352","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/insights_access_group_memberships","href":"insights-access-group-memberships/get insights access group memberships","openApiOperationId":"Get Insights Access Group Memberships","summary":"Fetching a list of Insights Access Group Memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Insights Access Group Memberships have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}},"schemaId":"schema_434"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1insights_access_group_memberships/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_434","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/insights_access_group_memberships"},{"label":"Creating a new Insights Access Group Membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-access-group-memberships/create insights access group membership","routeSlug":"/kantata/specification/insights-access-group-memberships/create insights access group membership","metadata":{"seo":{"title":"Creating a new Insights Access Group Membership","description":"Adds a user to an Insights Access Group. Only Account Administrators can add users to Insights Access Groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Insights Access Group Membership","name":"Creating a new Insights Access Group Membership","isWebhook":false,"pointer":"/paths/~1insights_access_group_memberships/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Insights Access Group Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a user to an Insights Access Group. Only Account Administrators can add users to Insights Access Groups."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Insights Access Group Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insights_access_group_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - References the associated user."},{"name":"optional_fields","in":"query","schemaId":"schema_433","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1insights_access_group_memberships/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_435"}},"schemaId":"schema_435","pointer":"/paths/~1insights_access_group_memberships/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/insights_access_group_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_433","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_435"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/insights_access_group_memberships","href":"insights-access-group-memberships/create insights access group membership","openApiOperationId":"Create Insights Access Group Membership","summary":"Creating a new Insights Access Group Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_435","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_435"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Insights Access Group Membership has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}},"schemaId":"schema_434"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1insights_access_group_memberships/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_434","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/insights_access_group_memberships"},{"label":"Fetching a single Insights Access Group Membership","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-access-group-memberships/get insights access group membership","routeSlug":"/kantata/specification/insights-access-group-memberships/get insights access group membership","metadata":{"seo":{"title":"Fetching a single Insights Access Group Membership","description":"This endpoint returns structured Insights Access Group Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the insights_access_group_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Insights Access Group Membership","name":"Fetching a single Insights Access Group Membership","isWebhook":false,"pointer":"/paths/~1insights_access_group_memberships~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Insights Access Group Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Insights Access Group Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insights_access_group_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1insights_access_group_memberships~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - References the associated user."},{"name":"optional_fields","in":"query","schemaId":"schema_433","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1insights_access_group_memberships~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/insights_access_group_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_433","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/insights_access_group_memberships/{id}","href":"insights-access-group-memberships/get insights access group membership","openApiOperationId":"Get Insights Access Group Membership","summary":"Fetching a single Insights Access Group Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Insights Access Group Membership has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}},"schemaId":"schema_434"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1insights_access_group_memberships~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_434","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/insights_access_group_memberships/{id}"},{"label":"Updating an existing Insights Access Group Membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-access-group-memberships/update insights access group membership","routeSlug":"/kantata/specification/insights-access-group-memberships/update insights access group membership","metadata":{"seo":{"title":"Updating an existing Insights Access Group Membership","description":"Only Account Administrators can update Insights Access Group Memberships."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Insights Access Group Membership","name":"Updating an existing Insights Access Group Membership","isWebhook":false,"pointer":"/paths/~1insights_access_group_memberships~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Insights Access Group Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only Account Administrators can update Insights Access Group Memberships."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": To move a user from one Insights Access Group to another, delete the existing Access Group"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Membership, then create a new one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Insights Access Group Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insights_access_group_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1insights_access_group_memberships~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - References the associated user."},{"name":"optional_fields","in":"query","schemaId":"schema_433","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1insights_access_group_memberships~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_436"}},"schemaId":"schema_436","pointer":"/paths/~1insights_access_group_memberships~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/insights_access_group_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_433","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_436"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/insights_access_group_memberships/{id}","href":"insights-access-group-memberships/update insights access group membership","openApiOperationId":"Update Insights Access Group Membership","summary":"Updating an existing Insights Access Group Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_436","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_436"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Insights Access Group Membership has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}},"schemaId":"schema_434"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1insights_access_group_memberships~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_434","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/insights_access_group_memberships/{id}"},{"label":"Deleting an existing Insights Access Group Membership","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-access-group-memberships/delete insights access group membership","routeSlug":"/kantata/specification/insights-access-group-memberships/delete insights access group membership","metadata":{"seo":{"title":"Deleting an existing Insights Access Group Membership","description":"Removes a user from an Insights Access Group. Only Account Administrators candelete Insights Access Group Memberships."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Insights Access Group Membership","name":"Deleting an existing Insights Access Group Membership","isWebhook":false,"pointer":"/paths/~1insights_access_group_memberships~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Insights Access Group Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes a user from an Insights Access Group. Only Account Administrators can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delete Insights Access Group Memberships."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1insights_access_group_memberships~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/insights_access_group_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/insights_access_group_memberships/{id}","href":"insights-access-group-memberships/delete insights access group membership","openApiOperationId":"Delete Insights Access Group Membership","summary":"Deleting an existing Insights Access Group Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Insights Access Group Membership has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1insights_access_group_memberships~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/insights_access_group_memberships/{id}"}],"content":{"contentType":"group","meta":{"name":"Insights Access Group Memberships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insights Access Group Memberships","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/115002115073"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Insights Access Groups"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allow you to manage classic Insights access for users. An Insights Access"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Group Membership represents the connection of a user to an Insights Access Group."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": To manage access to dynamic Insights, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Access-Group-Memberships"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Group Memberships"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/insights_access_group_memberships","summary":"Fetching a list of Insights Access Group Memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/insights-access-group-memberships/get insights access group memberships","deprecated":false},{"title":"/insights_access_group_memberships","summary":"Creating a new Insights Access Group Membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/insights-access-group-memberships/create insights access group membership","deprecated":false},{"title":"/insights_access_group_memberships/{id}","summary":"Fetching a single Insights Access Group Membership","prefix":{"name":"get","color":"get"},"badges":[],"link":"/insights-access-group-memberships/get insights access group membership","deprecated":false},{"title":"/insights_access_group_memberships/{id}","summary":"Updating an existing Insights Access Group Membership","prefix":{"name":"put","color":"put"},"badges":[],"link":"/insights-access-group-memberships/update insights access group membership","deprecated":false},{"title":"/insights_access_group_memberships/{id}","summary":"Deleting an existing Insights Access Group Membership","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/insights-access-group-memberships/delete insights access group membership","deprecated":false}]}]}]}]}},{"type":"group","label":"Insights Dynamic Dashboards","link":"/kantata/specification/insights-dynamic-dashboards","routeSlug":"/kantata/specification/insights-dynamic-dashboards","items":[{"label":"Get Insights Dynamic Dashboards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-dynamic-dashboards/list insights mapping dashboards","routeSlug":"/kantata/specification/insights-dynamic-dashboards/list insights mapping dashboards","metadata":{"seo":{"title":"Get Insights Dynamic Dashboards","description":"Returns a list of Dynamic Account Insights Mappings (i.e. Insights dynamic dashboards) that are visible to the authenticated user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List Insights Mapping Dashboards","name":"Get Insights Dynamic Dashboards","isWebhook":false,"pointer":"/paths/~1account_insights_mappings~1dynamic/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Insights Dynamic Dashboards","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of Dynamic Account Insights Mappings (i.e. Insights dynamic dashboards) that are visible to the authenticated user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Account Insights Mapping objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_insights_mappings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `access_groups` (AccessGroup) - Retrieves the Access Groups the dashboard has been shared with. The response will include `access_group_ids`, which references the data in the `access_groups` top-level key."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Filter for dashboards with a name that match the specified string. This filter is not case sensitive."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_343","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `alphabetical:asc`, `alphabetical:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"standard","in":"query","schemaId":"schema_305","description":"Return only standard dashboards (`true`) or only custom dashboards (`false`)."}],"pointer":"/paths/~1account_insights_mappings~1dynamic/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_insights_mappings/dynamic","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_343"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"standard","in":"query","schemaId":"schema_305"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_insights_mappings/dynamic","href":"insights-dynamic-dashboards/list insights mapping dashboards","openApiOperationId":"List Insights Mapping Dashboards","summary":"Get Insights Dynamic Dashboards"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Account Insights Mappings have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}},"schemaId":"schema_437"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_insights_mappings~1dynamic/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_437","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_insights_mappings/dynamic"}],"content":{"contentType":"group","meta":{"name":"Insights Dynamic Dashboards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insights Dynamic Dashboards","showPageActions":true},{"nodeType":"markdoc","content":"Built with an easy-to-use, modern, and intuitive dashboard editor, Insights dynamic dashboards are based on\nthe same powerful data engine as classic dashboards and help you make data-driven decisions for projects,\nstaffing, and more. Use this API to get information about dynamic dashboards on your account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_insights_mappings/dynamic","summary":"Get Insights Dynamic Dashboards","prefix":{"name":"get","color":"get"},"badges":[],"link":"/insights-dynamic-dashboards/list insights mapping dashboards","deprecated":false}]}]}]}]}},{"type":"group","label":"Insights Report Exports","link":"/kantata/specification/insights-report-exports","routeSlug":"/kantata/specification/insights-report-exports","items":[{"label":"Get Scheduled Report Exports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-report-exports/get scheduled report exports","routeSlug":"/kantata/specification/insights-report-exports/get scheduled report exports","metadata":{"seo":{"title":"Get Scheduled Report Exports","description":"Returns a list of scheduled exports of classic Insights reports."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Scheduled Report Exports","name":"Get Scheduled Report Exports","isWebhook":false,"pointer":"/paths/~1scheduled_jobs~1insights_report_exports/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Scheduled Report Exports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of scheduled exports of classic Insights reports."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scheduled_jobs/insights_report_exports","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/scheduled_jobs/insights_report_exports","href":"insights-report-exports/get scheduled report exports","openApiOperationId":"Get Scheduled Report Exports","summary":"Get Scheduled Report Exports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Insights Report Exports have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_438"}},"schemaId":"schema_438"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1scheduled_jobs~1insights_report_exports/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_438","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_438"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/scheduled_jobs/insights_report_exports"},{"label":"Create a new Scheduled Report Export","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-report-exports/create scheduled report export","routeSlug":"/kantata/specification/insights-report-exports/create scheduled report export","metadata":{"seo":{"title":"Create a new Scheduled Report Export","description":"Create a new scheduled job. Set a schedule for a classic Insights report to be exported from Kantata OX to download later. You will need to write a script to download the report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Scheduled Report Export","name":"Create a new Scheduled Report Export","isWebhook":false,"pointer":"/paths/~1scheduled_jobs~1insights_report_exports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Scheduled Report Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new scheduled job. Set a schedule for a classic Insights report to be exported from Kantata OX to download later. You will need to write a script to download the report."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_439"}},"schemaId":"schema_439","pointer":"/paths/~1scheduled_jobs~1insights_report_exports/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scheduled_jobs/insights_report_exports","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_439"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/scheduled_jobs/insights_report_exports","href":"insights-report-exports/create scheduled report export","openApiOperationId":"Create Scheduled Report Export","summary":"Create a new Scheduled Report Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_439","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_439"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Insights Report Export has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}},"schemaId":"schema_440"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1scheduled_jobs~1insights_report_exports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_440","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/scheduled_jobs/insights_report_exports"},{"label":"Get Scheduled Report Export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-report-exports/get scheduled report export","routeSlug":"/kantata/specification/insights-report-exports/get scheduled report export","metadata":{"seo":{"title":"Get Scheduled Report Export","description":"Returns details for a single scheduled export of a classic Insights report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Scheduled Report Export","name":"Get Scheduled Report Export","isWebhook":false,"pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Scheduled Report Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns details for a single scheduled export of a classic Insights report."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scheduled_jobs/insights_report_exports/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/scheduled_jobs/insights_report_exports/{id}","href":"insights-report-exports/get scheduled report export","openApiOperationId":"Get Scheduled Report Export","summary":"Get Scheduled Report Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Insights Report Export has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}},"schemaId":"schema_440"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_440","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/scheduled_jobs/insights_report_exports/{id}"},{"label":"Update a Scheduled Report Export","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-report-exports/update scheduled report export","routeSlug":"/kantata/specification/insights-report-exports/update scheduled report export","metadata":{"seo":{"title":"Update a Scheduled Report Export","description":"Make changes to an existing scheduled job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Scheduled Report Export","name":"Update a Scheduled Report Export","isWebhook":false,"pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Scheduled Report Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Make changes to an existing scheduled job."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_441"}},"schemaId":"schema_441","pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/scheduled_jobs/insights_report_exports/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_441"}},"responseCodes":["400","401","403","404","422","503"],"pointer":"/scheduled_jobs/insights_report_exports/{id}","href":"insights-report-exports/update scheduled report export","openApiOperationId":"Update Scheduled Report Export","summary":"Update a Scheduled Report Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_441","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_441"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/scheduled_jobs/insights_report_exports/{id}"},{"label":"Delete an existing Scheduled Report Export","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-report-exports/delete scheduled report export","routeSlug":"/kantata/specification/insights-report-exports/delete scheduled report export","metadata":{"seo":{"title":"Delete an existing Scheduled Report Export","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Scheduled Report Export","name":"Delete an existing Scheduled Report Export","isWebhook":false,"pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an existing Scheduled Report Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/scheduled_jobs/insights_report_exports/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/scheduled_jobs/insights_report_exports/{id}","href":"insights-report-exports/delete scheduled report export","openApiOperationId":"Delete Scheduled Report Export","summary":"Delete an existing Scheduled Report Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Insights Report Export has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/scheduled_jobs/insights_report_exports/{id}"},{"label":"Get Latest Export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-report-exports/get latest scheduled report export","routeSlug":"/kantata/specification/insights-report-exports/get latest scheduled report export","metadata":{"seo":{"title":"Get Latest Export","description":"Returns the most recent classic Insights report that has been successfully and completely exported by a scheduled job. The response contains a URL to download the report, as well as a timestamp for when the data in the report was last updated, so you may determine if the report reflects current data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Latest Scheduled Report Export","name":"Get Latest Export","isWebhook":false,"pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{insights_report_export_id}~1results~1latest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Latest Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the most recent classic Insights report that has been successfully and completely exported by a scheduled job. The response contains a URL to download the report, as well as a timestamp for when the data in the report was last updated, so you may determine if the report reflects current data.\n\nIn order to keep exported data secure, the URL returned in the response expires in 60 seconds. The URL expiration period is subject to change. If you do not initiate a download of the report before the link expires, you can send a new request to generate a new URL.\n\nExporting a report can take from seconds to 20 minutes, depending on the report size. Because export time varies, please send requests until the latest data is returned. If there are no previously exported reports yet, the response code and message will indicate this.\n\nBecause exported reports can be up to 10 GB, reports are downloaded in a compressed format (.gz) and must be decompressed in order to access the CSV file."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"insights_report_export_id","in":"path","schemaId":"schema_316","description":"The ID of the Insights report export.","required":true}],"pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{insights_report_export_id}~1results~1latest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scheduled_jobs/insights_report_exports/{insights_report_export_id}/results/latest","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"insights_report_export_id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/scheduled_jobs/insights_report_exports/{insights_report_export_id}/results/latest","href":"insights-report-exports/get latest scheduled report export","openApiOperationId":"Get Latest Scheduled Report Export","summary":"Get Latest Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Insights Report Exports have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}},"schemaId":"schema_442"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1scheduled_jobs~1insights_report_exports~1{insights_report_export_id}~1results~1latest/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_442","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/scheduled_jobs/insights_report_exports/{insights_report_export_id}/results/latest"}],"content":{"contentType":"group","meta":{"name":"Insights Report Exports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insights Report Exports","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows you to manage scheduled exports of classic Insights reports from Kantata OX. An export of a classic Insights report that is scheduled to recur is called a scheduled job. You can create, update, and delete scheduled jobs. You can also view details of all the exports for a scheduled job, view the details of each export individually, and download the most recently exported report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use these endpoints, you need to be an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/203041364"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account administrator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scheduled_jobs/insights_report_exports","summary":"Get Scheduled Report Exports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/insights-report-exports/get scheduled report exports","deprecated":false},{"title":"/scheduled_jobs/insights_report_exports","summary":"Create a new Scheduled Report Export","prefix":{"name":"post","color":"post"},"badges":[],"link":"/insights-report-exports/create scheduled report export","deprecated":false},{"title":"/scheduled_jobs/insights_report_exports/{id}","summary":"Get Scheduled Report Export","prefix":{"name":"get","color":"get"},"badges":[],"link":"/insights-report-exports/get scheduled report export","deprecated":false},{"title":"/scheduled_jobs/insights_report_exports/{id}","summary":"Update a Scheduled Report Export","prefix":{"name":"put","color":"put"},"badges":[],"link":"/insights-report-exports/update scheduled report export","deprecated":false},{"title":"/scheduled_jobs/insights_report_exports/{id}","summary":"Delete an existing Scheduled Report Export","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/insights-report-exports/delete scheduled report export","deprecated":false},{"title":"/scheduled_jobs/insights_report_exports/{insights_report_export_id}/results/latest","summary":"Get Latest Export","prefix":{"name":"get","color":"get"},"badges":[],"link":"/insights-report-exports/get latest scheduled report export","deprecated":false}]}]}]}]}},{"type":"group","label":"Insights Reports","link":"/kantata/specification/insights-reports","routeSlug":"/kantata/specification/insights-reports","items":[{"label":"Get Insights Reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/insights-reports/get insights reports","routeSlug":"/kantata/specification/insights-reports/get insights reports","metadata":{"seo":{"title":"Get Insights Reports","description":"Returns a list of classic Insights reports on your Kantata OX account. When a title is provided, reports that match the title are returned. When a title is not provided, all classic Insights reports on your account are returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Insights Reports","name":"Get Insights Reports","isWebhook":false,"pointer":"/paths/~1insights_reports/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Insights Reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of classic Insights reports on your Kantata OX account. When a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, reports that match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned. When a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided, all classic Insights reports on your account are returned."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"title","in":"query","schemaId":"schema_304","description":"Specify the title of the report you would like to find similar matches for."}],"pointer":"/paths/~1insights_reports/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/insights_reports","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"title","in":"query","required":false,"schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/insights_reports","href":"insights-reports/get insights reports","openApiOperationId":"Get Insights Reports","summary":"Get Insights Reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Insights Reports have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_443"}},"schemaId":"schema_443"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1insights_reports/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_443","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_443"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/insights_reports"}],"content":{"contentType":"group","meta":{"name":"Insights Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insights Reports","showPageActions":true},{"nodeType":"markdoc","content":"View a list of classic Insights reports."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/insights_reports","summary":"Get Insights Reports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/insights-reports/get insights reports","deprecated":false}]}]}]}]}},{"type":"separator","label":"Invoices","content":null},{"type":"group","label":"Client Invoice Defaults","link":"/kantata/specification/client-invoice-defaults","routeSlug":"/kantata/specification/client-invoice-defaults","items":[{"label":"Fetching a list of Client Invoice Defaults","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/client-invoice-defaults/get client invoice defaults","routeSlug":"/kantata/specification/client-invoice-defaults/get client invoice defaults","metadata":{"seo":{"title":"Fetching a list of Client Invoice Defaults","description":"This endpoint returns structured Client Invoice Defaults objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the client_invoice_defaults top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Client Invoice Defaults","name":"Fetching a list of Client Invoice Defaults","isWebhook":false,"pointer":"/paths/~1client_invoice_defaults/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Client Invoice Defaults","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Client Invoice Defaults objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_invoice_defaults"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"client_user_id","in":"query","schemaId":"schema_313","description":"The user ID of the client."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"The ID of the project for which you are creating the invoice."}],"pointer":"/paths/~1client_invoice_defaults/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/client_invoice_defaults","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"client_user_id","in":"query","schemaId":"schema_313"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/client_invoice_defaults","href":"client-invoice-defaults/get client invoice defaults","openApiOperationId":"Get Client Invoice Defaults","summary":"Fetching a list of Client Invoice Defaults"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Client Invoice Defaults have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}},"schemaId":"schema_444"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1client_invoice_defaults/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_444","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/client_invoice_defaults"},{"label":"Creating Client Invoice Defaults","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/client-invoice-defaults/create client invoice defaults","routeSlug":"/kantata/specification/client-invoice-defaults/create client invoice defaults","metadata":{"seo":{"title":"Creating Client Invoice Defaults","description":"This endpoint returns structured Client Invoice Defaults objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the client_invoice_defaults top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Client Invoice Defaults","name":"Creating Client Invoice Defaults","isWebhook":false,"pointer":"/paths/~1client_invoice_defaults/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating Client Invoice Defaults","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Client Invoice Defaults objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_invoice_defaults"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_445"}},"schemaId":"schema_445","pointer":"/paths/~1client_invoice_defaults/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/client_invoice_defaults","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_445"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/client_invoice_defaults","href":"client-invoice-defaults/create client invoice defaults","openApiOperationId":"Create Client Invoice Defaults","summary":"Creating Client Invoice Defaults"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_445","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_445"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Client Invoice Defaults has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}},"schemaId":"schema_444"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1client_invoice_defaults/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_444","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/client_invoice_defaults"},{"label":"Fetching Client Invoice Defaults by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/client-invoice-defaults/get client invoice defaults by id","routeSlug":"/kantata/specification/client-invoice-defaults/get client invoice defaults by id","metadata":{"seo":{"title":"Fetching Client Invoice Defaults by ID","description":"This endpoint returns structured Client Invoice Defaults objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the client_invoice_defaults top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Client Invoice Defaults By Id","name":"Fetching Client Invoice Defaults by ID","isWebhook":false,"pointer":"/paths/~1client_invoice_defaults~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching Client Invoice Defaults by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Client Invoice Defaults objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_invoice_defaults"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1client_invoice_defaults~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/client_invoice_defaults/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/client_invoice_defaults/{id}","href":"client-invoice-defaults/get client invoice defaults by id","openApiOperationId":"Get Client Invoice Defaults By Id","summary":"Fetching Client Invoice Defaults by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Client Invoice Defaults has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}},"schemaId":"schema_444"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1client_invoice_defaults~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_444","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/client_invoice_defaults/{id}"},{"label":"Updating Client Invoice Defaults by ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/client-invoice-defaults/update client invoice defaults by id","routeSlug":"/kantata/specification/client-invoice-defaults/update client invoice defaults by id","metadata":{"seo":{"title":"Updating Client Invoice Defaults by ID","description":"This endpoint returns structured Client Invoice Defaults objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the client_invoice_defaults top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Client Invoice Defaults By Id","name":"Updating Client Invoice Defaults by ID","isWebhook":false,"pointer":"/paths/~1client_invoice_defaults~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating Client Invoice Defaults by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Client Invoice Defaults objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_invoice_defaults"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1client_invoice_defaults~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_446"}},"schemaId":"schema_446","pointer":"/paths/~1client_invoice_defaults~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/client_invoice_defaults/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_446"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/client_invoice_defaults/{id}","href":"client-invoice-defaults/update client invoice defaults by id","openApiOperationId":"Update Client Invoice Defaults By Id","summary":"Updating Client Invoice Defaults by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_446","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_446"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Client Invoice Defaults has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}},"schemaId":"schema_444"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1client_invoice_defaults~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_444","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/client_invoice_defaults/{id}"},{"label":"Deleting Client Invoice Defaults by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/client-invoice-defaults/delete client invoice defaults by id","routeSlug":"/kantata/specification/client-invoice-defaults/delete client invoice defaults by id","metadata":{"seo":{"title":"Deleting Client Invoice Defaults by ID","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Client Invoice Defaults By Id","name":"Deleting Client Invoice Defaults by ID","isWebhook":false,"pointer":"/paths/~1client_invoice_defaults~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting Client Invoice Defaults by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1client_invoice_defaults~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/client_invoice_defaults/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/client_invoice_defaults/{id}","href":"client-invoice-defaults/delete client invoice defaults by id","openApiOperationId":"Delete Client Invoice Defaults By Id","summary":"Deleting Client Invoice Defaults by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Client Invoice Defaults has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1client_invoice_defaults~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/client_invoice_defaults/{id}"}],"content":{"contentType":"group","meta":{"name":"Client Invoice Defaults"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Client Invoice Defaults","showPageActions":true},{"nodeType":"markdoc","content":"Represents the default configuration for presenting invoices to clients."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/client_invoice_defaults","summary":"Fetching a list of Client Invoice Defaults","prefix":{"name":"get","color":"get"},"badges":[],"link":"/client-invoice-defaults/get client invoice defaults","deprecated":false},{"title":"/client_invoice_defaults","summary":"Creating Client Invoice Defaults","prefix":{"name":"post","color":"post"},"badges":[],"link":"/client-invoice-defaults/create client invoice defaults","deprecated":false},{"title":"/client_invoice_defaults/{id}","summary":"Fetching Client Invoice Defaults by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/client-invoice-defaults/get client invoice defaults by id","deprecated":false},{"title":"/client_invoice_defaults/{id}","summary":"Updating Client Invoice Defaults by ID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/client-invoice-defaults/update client invoice defaults by id","deprecated":false},{"title":"/client_invoice_defaults/{id}","summary":"Deleting Client Invoice Defaults by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/client-invoice-defaults/delete client invoice defaults by id","deprecated":false}]}]}]}]}},{"type":"group","label":"External Payments","link":"/kantata/specification/external-payments","routeSlug":"/kantata/specification/external-payments","items":[{"label":"Fetching a list of External Payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/external-payments/get external payments","routeSlug":"/kantata/specification/external-payments/get external payments","metadata":{"seo":{"title":"Fetching a list of External Payments","description":"The external payments currently visible to the user that is logged-in."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get External Payments","name":"Fetching a list of External Payments","isWebhook":false,"pointer":"/paths/~1external_payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of External Payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external payments currently visible to the user that is logged-in."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured External Payment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `invoice` (Invoice) - The invoice (if any) for which the external payment was created.\n- `user` (User) - The user who created the external payment.\n- `workspace` (Workspace) - The project in which the external payment was created."},{"name":"invoice_id","in":"query","schemaId":"schema_313","description":"Limit returned external payments to those paying the invoice with the specified ID."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `id:asc`, `id:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"user_id","in":"query","schemaId":"schema_313","description":"Limit returned external payments to those created by the user with the specified ID."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Limit returned external payments to those logged within the specified workspace_id."}],"pointer":"/paths/~1external_payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/external_payments","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"invoice_id","in":"query","schemaId":"schema_313"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"user_id","in":"query","schemaId":"schema_313"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/external_payments","href":"external-payments/get external payments","openApiOperationId":"Get External Payments","summary":"Fetching a list of External Payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of External Payments have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}},"schemaId":"schema_447"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1external_payments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_447","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/external_payments"},{"label":"Creating a new External Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/external-payments/create external payment","routeSlug":"/kantata/specification/external-payments/create external payment","metadata":{"seo":{"title":"Creating a new External Payment","description":"Creates an external payment for the specified project or invoice. If an invoice ID is provided, apayment is only created for that invoice when it's a single project invoice and in a non-draft pending state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create External Payment","name":"Creating a new External Payment","isWebhook":false,"pointer":"/paths/~1external_payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new External Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an external payment for the specified project or invoice. If an invoice ID is provided, a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment is only created for that invoice when it's a single project invoice and in a non-draft pending state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured External Payment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `invoice` (Invoice) - The invoice (if any) for which the external payment was created.\n- `user` (User) - The user who created the external payment.\n- `workspace` (Workspace) - The project in which the external payment was created."}],"pointer":"/paths/~1external_payments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_448"}},"schemaId":"schema_448","pointer":"/paths/~1external_payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/external_payments","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_448"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/external_payments","href":"external-payments/create external payment","openApiOperationId":"Create External Payment","summary":"Creating a new External Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_448","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_448"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"External Payment has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}},"schemaId":"schema_447"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1external_payments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_447","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/external_payments"},{"label":"Fetching a single External Payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/external-payments/get external payment","routeSlug":"/kantata/specification/external-payments/get external payment","metadata":{"seo":{"title":"Fetching a single External Payment","description":"This endpoint returns structured External Payment objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the external_payments top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get External Payment","name":"Fetching a single External Payment","isWebhook":false,"pointer":"/paths/~1external_payments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single External Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured External Payment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1external_payments~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `invoice` (Invoice) - The invoice (if any) for which the external payment was created.\n- `user` (User) - The user who created the external payment.\n- `workspace` (Workspace) - The project in which the external payment was created."}],"pointer":"/paths/~1external_payments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/external_payments/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/external_payments/{id}","href":"external-payments/get external payment","openApiOperationId":"Get External Payment","summary":"Fetching a single External Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The External Payment has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}},"schemaId":"schema_447"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1external_payments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_447","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/external_payments/{id}"},{"label":"Deleting an existing External Payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/external-payments/delete external payment","routeSlug":"/kantata/specification/external-payments/delete external payment","metadata":{"seo":{"title":"Deleting an existing External Payment","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete External Payment","name":"Deleting an existing External Payment","isWebhook":false,"pointer":"/paths/~1external_payments~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing External Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1external_payments~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/external_payments/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/external_payments/{id}","href":"external-payments/delete external payment","openApiOperationId":"Delete External Payment","summary":"Deleting an existing External Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"External Payment has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1external_payments~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/external_payments/{id}"}],"content":{"contentType":"group","meta":{"name":"External Payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Payments","showPageActions":true},{"nodeType":"markdoc","content":"An external payment is a manual record of a payment made outside of Kantata OX. An external payment can\nbe applied to an invoice, or just recorded directly to a project."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/external_payments","summary":"Fetching a list of External Payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/external-payments/get external payments","deprecated":false},{"title":"/external_payments","summary":"Creating a new External Payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/external-payments/create external payment","deprecated":false},{"title":"/external_payments/{id}","summary":"Fetching a single External Payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/external-payments/get external payment","deprecated":false},{"title":"/external_payments/{id}","summary":"Deleting an existing External Payment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/external-payments/delete external payment","deprecated":false}]}]}]}]}},{"type":"group","label":"Invoices","link":"/kantata/specification/invoices","routeSlug":"/kantata/specification/invoices","items":[{"label":"Fetching a list of Invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/invoices/get invoices","routeSlug":"/kantata/specification/invoices/get invoices","metadata":{"seo":{"title":"Fetching a list of Invoices","description":"This endpoint returns structured Invoice objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the invoices top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Invoices","name":"Fetching a list of Invoices","isWebhook":false,"pointer":"/paths/~1invoices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Invoices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Invoice objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `additional_items` (AdditionalItem) - When included, the `additional_item_ids` array will reference all additional items included in the invoice.\n- `billing_milestones` (BillingMilestone) - When included, the `billing_milestone_ids` array will reference all billing milestones included in the invoice.\n- `expenses` (Expense) - When included, the `expense_ids` array will reference all expenses included in the invoice.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `fixed_fee_items` (FixedFeeItem) - When included, the `fixed_fee_items` array will reference all fixed fee items included in the invoice.\n- `recipient` (User) - The User who received the invoice. Namely, the client lead at the time that the invoice\nwas created (or null, if no lead client existed at the time).\n- `time_entries` (TimeEntry) - When included, the `time_entry_ids` array will reference all time entries included in the invoice.\n- `user` (User) - The user who created the invoice.\n- `workspaces` (Workspace) - When included, the `workspace_ids` array will reference all projects covered by the invoice."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `id:asc`, `id:desc`, `invoice_date:asc`, `invoice_date:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"paid","in":"query","schemaId":"schema_351","description":"When `true` is passed, only paid invoices are returned."},{"name":"pending","in":"query","schemaId":"schema_351","description":"When `true` is passed, only non-accepted, non-draft invoices are returned."},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"user_invoice_number","in":"query","schemaId":"schema_304","description":"Provide one or more user invoice numbers, separated by commas. When provided, only invoices\n with the specified user invoice numbers will be returned."},{"name":"within_dates","in":"query","schemaId":"schema_304","description":"Provide a date range in 2000-01-01:2000-12-31 format. When provided, only invoices created\n within the specified range will be returned."},{"name":"without_drafts","in":"query","schemaId":"schema_351","description":"When `true` is passed, draft invoices will not be returned."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_304","description":"Provide one or more workspace IDs, separated by commas. If present, only invoices\n in the provided projects will be returned."}],"pointer":"/paths/~1invoices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"paid","in":"query","schemaId":"schema_351"},{"name":"pending","in":"query","schemaId":"schema_351"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"user_invoice_number","in":"query","schemaId":"schema_304"},{"name":"within_dates","in":"query","schemaId":"schema_304"},{"name":"without_drafts","in":"query","schemaId":"schema_351"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/invoices","href":"invoices/get invoices","openApiOperationId":"Get Invoices","summary":"Fetching a list of Invoices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Invoices have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}},"schemaId":"schema_449"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1invoices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_449","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/invoices"},{"label":"Creating a new Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/invoices/create invoice","routeSlug":"/kantata/specification/invoices/create invoice","metadata":{"seo":{"title":"Creating a new Invoice","description":"This endpoint returns structured Invoice objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the invoices top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Invoice","name":"Creating a new Invoice","isWebhook":false,"pointer":"/paths/~1invoices/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Invoice objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `additional_items` (AdditionalItem) - When included, the `additional_item_ids` array will reference all additional items included in the invoice.\n- `billing_milestones` (BillingMilestone) - When included, the `billing_milestone_ids` array will reference all billing milestones included in the invoice.\n- `expenses` (Expense) - When included, the `expense_ids` array will reference all expenses included in the invoice.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `fixed_fee_items` (FixedFeeItem) - When included, the `fixed_fee_items` array will reference all fixed fee items included in the invoice.\n- `recipient` (User) - The User who received the invoice. Namely, the client lead at the time that the invoice\nwas created (or null, if no lead client existed at the time).\n- `time_entries` (TimeEntry) - When included, the `time_entry_ids` array will reference all time entries included in the invoice.\n- `user` (User) - The user who created the invoice.\n- `workspaces` (Workspace) - When included, the `workspace_ids` array will reference all projects covered by the invoice."}],"pointer":"/paths/~1invoices/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_450"}},"schemaId":"schema_450","pointer":"/paths/~1invoices/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_450"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/invoices","href":"invoices/create invoice","openApiOperationId":"Create Invoice","summary":"Creating a new Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_450","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_450"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}},"schemaId":"schema_449"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1invoices/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_449","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/invoices"},{"label":"Retrieve the next available invoice number.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/invoices/get next invoice number","routeSlug":"/kantata/specification/invoices/get next invoice number","metadata":{"seo":{"title":"Retrieve the next available invoice number.","description":"Retrieve the next available invoice number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Next Invoice Number","name":"Retrieve the next available invoice number.","isWebhook":false,"pointer":"/paths/~1invoices~1next_invoice_number/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the next available invoice number.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"empty-message","label":"No request data","labelTranslationKey":"noRequestData"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/next_invoice_number","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/invoices/next_invoice_number","href":"invoices/get next invoice number","openApiOperationId":"Get Next Invoice Number","summary":"Retrieve the next available invoice number."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Invoices have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}},"schemaId":"schema_451"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1invoices~1next_invoice_number/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_451","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/invoices/next_invoice_number"},{"label":"Fetching a single Invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/invoices/get invoice","routeSlug":"/kantata/specification/invoices/get invoice","metadata":{"seo":{"title":"Fetching a single Invoice","description":"This endpoint returns structured Invoice objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the invoices top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Invoice","name":"Fetching a single Invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Invoice objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1invoices~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `additional_items` (AdditionalItem) - When included, the `additional_item_ids` array will reference all additional items included in the invoice.\n- `billing_milestones` (BillingMilestone) - When included, the `billing_milestone_ids` array will reference all billing milestones included in the invoice.\n- `expenses` (Expense) - When included, the `expense_ids` array will reference all expenses included in the invoice.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `fixed_fee_items` (FixedFeeItem) - When included, the `fixed_fee_items` array will reference all fixed fee items included in the invoice.\n- `recipient` (User) - The User who received the invoice. Namely, the client lead at the time that the invoice\nwas created (or null, if no lead client existed at the time).\n- `time_entries` (TimeEntry) - When included, the `time_entry_ids` array will reference all time entries included in the invoice.\n- `user` (User) - The user who created the invoice.\n- `workspaces` (Workspace) - When included, the `workspace_ids` array will reference all projects covered by the invoice."}],"pointer":"/paths/~1invoices~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/invoices/{id}","href":"invoices/get invoice","openApiOperationId":"Get Invoice","summary":"Fetching a single Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Invoice has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}},"schemaId":"schema_449"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1invoices~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_449","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/invoices/{id}"},{"label":"Updating an existing Invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/invoices/update invoice","routeSlug":"/kantata/specification/invoices/update invoice","metadata":{"seo":{"title":"Updating an existing Invoice","description":"This endpoint returns structured Invoice objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the invoices top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Invoice","name":"Updating an existing Invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Invoice objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1invoices~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `additional_items` (AdditionalItem) - When included, the `additional_item_ids` array will reference all additional items included in the invoice.\n- `billing_milestones` (BillingMilestone) - When included, the `billing_milestone_ids` array will reference all billing milestones included in the invoice.\n- `expenses` (Expense) - When included, the `expense_ids` array will reference all expenses included in the invoice.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `fixed_fee_items` (FixedFeeItem) - When included, the `fixed_fee_items` array will reference all fixed fee items included in the invoice.\n- `recipient` (User) - The User who received the invoice. Namely, the client lead at the time that the invoice\nwas created (or null, if no lead client existed at the time).\n- `time_entries` (TimeEntry) - When included, the `time_entry_ids` array will reference all time entries included in the invoice.\n- `user` (User) - The user who created the invoice.\n- `workspaces` (Workspace) - When included, the `workspace_ids` array will reference all projects covered by the invoice."}],"pointer":"/paths/~1invoices~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_452"}},"schemaId":"schema_452","pointer":"/paths/~1invoices~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/invoices/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_452"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/invoices/{id}","href":"invoices/update invoice","openApiOperationId":"Update Invoice","summary":"Updating an existing Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_452","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_452"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}},"schemaId":"schema_449"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1invoices~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_449","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/invoices/{id}"},{"label":"Deleting an existing Invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/invoices/delete invoice","routeSlug":"/kantata/specification/invoices/delete invoice","metadata":{"seo":{"title":"Deleting an existing Invoice","description":"You can delete draft invoices with this endpoint. Active invoices cannot bedeleted. They must be cancelled instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Invoice","name":"Deleting an existing Invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete draft invoices with this endpoint. Active invoices cannot be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted. They must be cancelled instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1invoices~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/invoices/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/invoices/{id}","href":"invoices/delete invoice","openApiOperationId":"Delete Invoice","summary":"Deleting an existing Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Invoice has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1invoices~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/invoices/{id}"},{"label":"Cancel an existing invoice.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/invoices/cancel invoice","routeSlug":"/kantata/specification/invoices/cancel invoice","metadata":{"seo":{"title":"Cancel an existing invoice.","description":"You can cancel active invoices with this endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Cancel Invoice","name":"Cancel an existing invoice.","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an existing invoice.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can cancel active invoices with this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Invoice objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1invoices~1{id}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `additional_items` (AdditionalItem) - When included, the `additional_item_ids` array will reference all additional items included in the invoice.\n- `billing_milestones` (BillingMilestone) - When included, the `billing_milestone_ids` array will reference all billing milestones included in the invoice.\n- `expenses` (Expense) - When included, the `expense_ids` array will reference all expenses included in the invoice.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `fixed_fee_items` (FixedFeeItem) - When included, the `fixed_fee_items` array will reference all fixed fee items included in the invoice.\n- `recipient` (User) - The User who received the invoice. Namely, the client lead at the time that the invoice\nwas created (or null, if no lead client existed at the time).\n- `time_entries` (TimeEntry) - When included, the `time_entry_ids` array will reference all time entries included in the invoice.\n- `user` (User) - The user who created the invoice.\n- `workspaces` (Workspace) - When included, the `workspace_ids` array will reference all projects covered by the invoice."}],"pointer":"/paths/~1invoices~1{id}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/invoices/{id}/cancel","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/invoices/{id}/cancel","href":"invoices/cancel invoice","openApiOperationId":"Cancel Invoice","summary":"Cancel an existing invoice."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}},"schemaId":"schema_449"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1invoices~1{id}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_449","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/invoices/{id}/cancel"}],"content":{"contentType":"group","meta":{"name":"Invoices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoices","showPageActions":true},{"nodeType":"markdoc","content":"Users can create Invoices in a Kantata OX project. An Invoice must have at least one line item (a time entry,\nexpense, fixed fee item, or additional item). By default, the recipient of an invoice is the primary client\nin the project. Manual formatting options are available to define the format and information that should be displayed on an\ninvoice.\n\nInvoices can only be created and viewed by participants with financial permission in a project."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/invoices","summary":"Fetching a list of Invoices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/get invoices","deprecated":false},{"title":"/invoices","summary":"Creating a new Invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/create invoice","deprecated":false},{"title":"/invoices/next_invoice_number","summary":"Retrieve the next available invoice number.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/get next invoice number","deprecated":false},{"title":"/invoices/{id}","summary":"Fetching a single Invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/get invoice","deprecated":false},{"title":"/invoices/{id}","summary":"Updating an existing Invoice","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/update invoice","deprecated":false},{"title":"/invoices/{id}","summary":"Deleting an existing Invoice","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invoices/delete invoice","deprecated":false},{"title":"/invoices/{id}/cancel","summary":"Cancel an existing invoice.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/cancel invoice","deprecated":false}]}]}]}]}},{"type":"group","label":"Workspace Invoice Preferences","link":"/kantata/specification/workspace-invoice-preferences","routeSlug":"/kantata/specification/workspace-invoice-preferences","items":[{"label":"Creating a new Workspace Invoice Preference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-invoice-preferences/create workspace invoice preferences","routeSlug":"/kantata/specification/workspace-invoice-preferences/create workspace invoice preferences","metadata":{"seo":{"title":"Creating a new Workspace Invoice Preference","description":"This endpoint returns structured Workspace Invoice Preference objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_invoice_preferences top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workspace Invoice Preferences","name":"Creating a new Workspace Invoice Preference","isWebhook":false,"pointer":"/paths/~1workspace_invoice_preferences/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Workspace Invoice Preference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Invoice Preference objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_invoice_preferences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_453"}},"schemaId":"schema_453","pointer":"/paths/~1workspace_invoice_preferences/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workspace_invoice_preferences","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_453"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_invoice_preferences","href":"workspace-invoice-preferences/create workspace invoice preferences","openApiOperationId":"Create Workspace Invoice Preferences","summary":"Creating a new Workspace Invoice Preference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_453","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_453"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Invoice Preference has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}},"schemaId":"schema_454"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_invoice_preferences/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_454","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_invoice_preferences"},{"label":"Fetching a single Workspace Invoice Preference","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-invoice-preferences/get workspace invoice preferences","routeSlug":"/kantata/specification/workspace-invoice-preferences/get workspace invoice preferences","metadata":{"seo":{"title":"Fetching a single Workspace Invoice Preference","description":"This endpoint returns structured Workspace Invoice Preference objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_invoice_preferences top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Invoice Preferences","name":"Fetching a single Workspace Invoice Preference","isWebhook":false,"pointer":"/paths/~1workspace_invoice_preferences~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Workspace Invoice Preference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Invoice Preference objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_invoice_preferences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_invoice_preferences~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_invoice_preferences/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_invoice_preferences/{id}","href":"workspace-invoice-preferences/get workspace invoice preferences","openApiOperationId":"Get Workspace Invoice Preferences","summary":"Fetching a single Workspace Invoice Preference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Workspace Invoice Preference has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}},"schemaId":"schema_454"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_invoice_preferences~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_454","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_invoice_preferences/{id}"},{"label":"Updating an existing Workspace Invoice Preference","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-invoice-preferences/update workspace invoice preferences","routeSlug":"/kantata/specification/workspace-invoice-preferences/update workspace invoice preferences","metadata":{"seo":{"title":"Updating an existing Workspace Invoice Preference","description":"This endpoint returns structured Workspace Invoice Preference objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_invoice_preferences top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workspace Invoice Preferences","name":"Updating an existing Workspace Invoice Preference","isWebhook":false,"pointer":"/paths/~1workspace_invoice_preferences~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Workspace Invoice Preference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Invoice Preference objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_invoice_preferences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_invoice_preferences~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_455"}},"schemaId":"schema_455","pointer":"/paths/~1workspace_invoice_preferences~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspace_invoice_preferences/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_455"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_invoice_preferences/{id}","href":"workspace-invoice-preferences/update workspace invoice preferences","openApiOperationId":"Update Workspace Invoice Preferences","summary":"Updating an existing Workspace Invoice Preference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_455","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_455"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Invoice Preference has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}},"schemaId":"schema_454"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_invoice_preferences~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_454","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_invoice_preferences/{id}"}],"content":{"contentType":"group","meta":{"name":"Workspace Invoice Preferences"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workspace Invoice Preferences","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workspace Invoice Preferences specify the default values that are applied to new invoices created for the specified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"project. It is only used for projects that have financials enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These preferences can only be created and updated by users who can manage invoice preferences"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the project. This can be found by querying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"can_manage_invoice_preferences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on Workspace."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workspace_invoice_preferences","summary":"Creating a new Workspace Invoice Preference","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workspace-invoice-preferences/create workspace invoice preferences","deprecated":false},{"title":"/workspace_invoice_preferences/{id}","summary":"Fetching a single Workspace Invoice Preference","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-invoice-preferences/get workspace invoice preferences","deprecated":false},{"title":"/workspace_invoice_preferences/{id}","summary":"Updating an existing Workspace Invoice Preference","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspace-invoice-preferences/update workspace invoice preferences","deprecated":false}]}]}]}]}},{"type":"separator","label":"Personal Settings","content":null},{"type":"group","label":"Users","link":"/kantata/specification/users","routeSlug":"/kantata/specification/users","items":[{"label":"Fetching visible users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/get users","routeSlug":"/kantata/specification/users/get users","metadata":{"seo":{"title":"Fetching visible users","description":"This endpoint allows you to access all visible users based on the permission level of the requester."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Users","name":"Fetching visible users","isWebhook":false,"pointer":"/paths/~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching visible users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to access all visible users based on the permission level of the requester."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This endpoint relies on project participation and will not return a member of your account"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"who is not in a project. To see all users on the account, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"on_my_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the requester is an Account Administrator, the request will return all users who are participating in a project on the requester's account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition, it will return users not on the requester's account if they are participating in any project with an account member (either on the requester's account or their own account)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the requester is not an Account Administrator, the request will only return users who are participating in a project with the requester."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account_id","in":"query","schemaId":"schema_313","description":"Only includes users on the specified account. This filter is not available in conjunction with the `on_my_account` option."},{"name":"account_role_ids","in":"query","schemaId":"schema_304","description":"Only includes users with a specified role ID. (Format: 'role_id,role_id')."},{"name":"all_contacts","in":"query","schemaId":"schema_305","description":"Returns all users in the requester's contact list."},{"name":"assignable_to_resource","in":"query","schemaId":"schema_313","description":"Only includes users who can be assigned to a project resource with a specified ID."},{"name":"belonging_to_orgs","in":"query","schemaId":"schema_304","description":"Only includes users that belong to the specified geographies or departments (Format: 'geo_id,geo_id;dept_id,dept_id')."},{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field choice value, represented as a string with the custom field ID, followed by a\ncolon, and then comma-separated custom field choice value IDs. The custom field choice value can also be\nthe word `blank`. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\n\nThe following formats are supported:\n\n- `custom_field_ID:choice_value_ID`\n- `custom_field_ID:choice_value_1_ID,choice_value_2_ID`\n- `custom_field_ID:blank`\n- `(custom_field_1_ID:choice_value_1_ID,choice_value_2_ID):(custom_field_2_ID:choice_value_3_ID)`."},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field currency value, represented as a string with the custom field ID, followed by a\ncolon, and then the currency value. Optionally, the currency [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473) can be supplied as well, separated\nfrom the currency value by another colon. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200.2:USD):(2:100)`."},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field date value, represented as a string with the custom field ID, followed by a\ncolon, the starting date, another colon, and then the ending date. You can provide both a starting date\nand ending date, or provide just one. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:2014-12-05:2014-12-25):(2:2014-12-05)`."},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field number value, represented as a string with the custom field ID, followed by a\ncolon, and then the number value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200):(2:101)`."},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field text value, represented as a string with the custom field ID, followed by a\ncolon, and then the text value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:something):(2:else)`\n- `(1:something):(1:else)` (multiple values for the same field, returns objects matching any value)\n- `1` (bare field ID with no value, returns all objects that have any value for that field)."},{"name":"by_email_address","in":"query","schemaId":"schema_304","description":"Only includes users whose email address exactly matches the specified address."},{"name":"by_email_addresses","in":"query","schemaId":"schema_304","description":"Return only users whose email addresses exactly match the specified email addresses.\nYou can provide a list of comma-separated email addresses as a query parameter in the request URL or\nprovide an array of email addresses in the request body. You can specify up to 200 email addresses."},{"name":"by_full_name","in":"query","schemaId":"schema_304","description":"Only includes users with all or part of the specified full name."},{"name":"by_full_name_or_account_role","in":"query","schemaId":"schema_304","description":"Only includes users with a matching full_name or default_role specified a search term."},{"name":"can_be_approver_in_workspace","in":"query","schemaId":"schema_313","description":"Only includes users that are providers and have financial access in a project with a specified ID."},{"name":"can_view_reports","in":"query","schemaId":"schema_305","description":"Only include users who have account level permission of reports viewer or above."},{"name":"clients_only","in":"query","schemaId":"schema_305","description":"Only includes users that are in at least one project as a client."},{"name":"consultants_only","in":"query","schemaId":"schema_305","description":"Only includes users that are in at least one project as a provider."},{"name":"contacts_on_different_account","in":"query","schemaId":"schema_305","description":"Returns all the users that are in the requester's contact list, but on seperate accounts."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304","description":"Filter by the presence of a custom field value for the specified comma-separated custom field ID(s)."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `manager` (User) - Retrieves the user's manager. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `role` (Role) - Retrieves the user's account role. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user's proficiency level (for skills which can be assigned proficiency levels).\n- `skills` (Skill) - Retrieves the user's skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.\n- `work_samples` (WorkSample) - Retrieves the user's portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key."},{"name":"is_project_lead","in":"query","schemaId":"schema_305","description":"Only include users who have account level permission of project lead or above."},{"name":"managers","in":"query","schemaId":"schema_351","description":"Only include users who are managers."},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"not_assigned_to","in":"query","schemaId":"schema_313","description":"Only includes users who are not assigned to a task with specified ID."},{"name":"not_following","in":"query","schemaId":"schema_313","description":"Only includes users who are not following a task with the specified ID."},{"name":"not_on_calendars","in":"query","schemaId":"schema_304","description":"Only includes users who are not added to the specified holiday calendars (Format: 'calendar_id,calendar_id,calendar_id'."},{"name":"not_participant_in","in":"query","schemaId":"schema_313","description":"Only includes users not participating in a project with a specified ID."},{"name":"on_my_account","in":"query","schemaId":"schema_305","description":"Returns all users on the requester's account."},{"name":"on_my_account_or_participant_in_workspace","in":"query","schemaId":"schema_313","description":"Returns all the users that are on the account, as well as all users participating in the provided workspace ID."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"only_possible_managees","in":"query","schemaId":"schema_305","description":"Only includes possible managees on the account."},{"name":"only_possible_managers","in":"query","schemaId":"schema_305","description":"Only includes possible managers on the account."},{"name":"optional_fields","in":"query","schemaId":"schema_365","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_343","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `alphabetical:asc` and `alphabetical:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"participant_in","in":"query","schemaId":"schema_313","description":"Only includes users participating in a project with a specified ID."},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"potential_followers_for_story","in":"query","schemaId":"schema_313","description":"Only includes users who are able to follow a task with the specified ID."},{"name":"provider_leads_on_account_projects","in":"query","schemaId":"schema_305","description":"Only includes users who are providers and leads in projects on the requester's account."},{"name":"search","in":"query","schemaId":"schema_304"},{"name":"show_disabled","in":"query","schemaId":"schema_351","description":"Includes users with an inactive account membership and users who have been disabled by the Kantata team."},{"name":"show_users_in_insights_groups","in":"query","schemaId":"schema_305","description":"Only includes users who have access to insights."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"with_created_estimates","in":"query","schemaId":"schema_351","description":"Only include users who have created an estimate."},{"name":"with_organizations","in":"query","schemaId":"schema_305","description":"Only includes users that have an organization (true) or only includes users that do not have an organization (false)."},{"name":"with_skills","in":"query","schemaId":"schema_304","description":"Only includes users with a set of skills at the specified levels (Format: '{'skill_id':[level,level],'skill_id':[level],'operation':''}')."},{"name":"with_users","in":"query","schemaId":"schema_352","description":"Include only users for the provided IDs (Format: 'id,id,id')."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"without_skills","in":"query","schemaId":"schema_304","description":"Only includes users without the specified set of skills (Format: 'id,id,id')."},{"name":"without_timesheet_submission","in":"query","schemaId":"schema_304","description":"Only include users who have not submitted a timesheet in a project between the specified start and end dates. (Format: 'workspace_id:start_date:end_date')."},{"name":"without_users","in":"query","schemaId":"schema_352","description":"Exclude users for the provided IDs (Format: 'id,id,id')."},{"name":"write_access_in","in":"query","schemaId":"schema_313","description":"Only includes users who are participating in a project with a specified ID, and are not read-only in the project."}],"pointer":"/paths/~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"account_id","in":"query","schemaId":"schema_313"},{"name":"account_role_ids","in":"query","schemaId":"schema_304"},{"name":"all_contacts","in":"query","required":false,"schemaId":"schema_305"},{"name":"assignable_to_resource","in":"query","schemaId":"schema_313"},{"name":"belonging_to_orgs","in":"query","schemaId":"schema_304"},{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304"},{"name":"by_email_address","in":"query","schemaId":"schema_304"},{"name":"by_email_addresses","in":"query","schemaId":"schema_304"},{"name":"by_full_name","in":"query","schemaId":"schema_304"},{"name":"by_full_name_or_account_role","in":"query","schemaId":"schema_304"},{"name":"can_be_approver_in_workspace","in":"query","schemaId":"schema_313"},{"name":"can_view_reports","in":"query","schemaId":"schema_305"},{"name":"clients_only","in":"query","schemaId":"schema_305"},{"name":"consultants_only","in":"query","schemaId":"schema_305"},{"name":"contacts_on_different_account","in":"query","required":false,"schemaId":"schema_305"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"is_project_lead","in":"query","schemaId":"schema_305"},{"name":"managers","in":"query","schemaId":"schema_351"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"not_assigned_to","in":"query","schemaId":"schema_313"},{"name":"not_following","in":"query","schemaId":"schema_313"},{"name":"not_on_calendars","in":"query","schemaId":"schema_304"},{"name":"not_participant_in","in":"query","schemaId":"schema_313"},{"name":"on_my_account","in":"query","required":false,"schemaId":"schema_305"},{"name":"on_my_account_or_participant_in_workspace","in":"query","required":false,"schemaId":"schema_313"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"only_possible_managees","in":"query","schemaId":"schema_305"},{"name":"only_possible_managers","in":"query","schemaId":"schema_305"},{"name":"optional_fields","in":"query","schemaId":"schema_365","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_343"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"participant_in","in":"query","schemaId":"schema_313"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"potential_followers_for_story","in":"query","schemaId":"schema_313"},{"name":"provider_leads_on_account_projects","in":"query","schemaId":"schema_305"},{"name":"search","in":"query","schemaId":"schema_304"},{"name":"show_disabled","in":"query","schemaId":"schema_351"},{"name":"show_users_in_insights_groups","in":"query","schemaId":"schema_305"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"with_created_estimates","in":"query","schemaId":"schema_351"},{"name":"with_organizations","in":"query","schemaId":"schema_305"},{"name":"with_skills","in":"query","schemaId":"schema_304"},{"name":"with_users","in":"query","schemaId":"schema_352","style":"form","explode":false},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"without_skills","in":"query","schemaId":"schema_304"},{"name":"without_timesheet_submission","in":"query","schemaId":"schema_304"},{"name":"without_users","in":"query","schemaId":"schema_352","style":"form","explode":false},{"name":"write_access_in","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/users","href":"users/get users","openApiOperationId":"Get Users","summary":"Fetching visible users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Users have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users"},{"label":"Fetch your own data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/get my user data","routeSlug":"/kantata/specification/users/get my user data","metadata":{"seo":{"title":"Fetch your own data","description":"This endpoint allows you to fetch your own data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get My User Data","name":"Fetch your own data","isWebhook":false,"pointer":"/paths/~1users~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch your own data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to fetch your own data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `manager` (User) - Retrieves the user's manager. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `role` (Role) - Retrieves the user's account role. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user's proficiency level (for skills which can be assigned proficiency levels).\n- `skills` (Skill) - Retrieves the user's skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.\n- `work_samples` (WorkSample) - Retrieves the user's portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_365","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1users~1me/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/me","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_365","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/users/me","href":"users/get my user data","openApiOperationId":"Get My User Data","summary":"Fetch your own data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Users have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users/me"},{"label":"Fetching a single User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/get user","routeSlug":"/kantata/specification/users/get user","metadata":{"seo":{"title":"Fetching a single User","description":"This endpoint returns structured User objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the users top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get User","name":"Fetching a single User","isWebhook":false,"pointer":"/paths/~1users~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1users~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `manager` (User) - Retrieves the user's manager. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `role` (Role) - Retrieves the user's account role. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user's proficiency level (for skills which can be assigned proficiency levels).\n- `skills` (Skill) - Retrieves the user's skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.\n- `work_samples` (WorkSample) - Retrieves the user's portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_365","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1users~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_365","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/users/{id}","href":"users/get user","openApiOperationId":"Get User","summary":"Fetching a single User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The User has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users/{id}"},{"label":"Updating an existing User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/update user","routeSlug":"/kantata/specification/users/update user","metadata":{"seo":{"title":"Updating an existing User","description":"This endpoint returns structured User objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the users top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update User","name":"Updating an existing User","isWebhook":false,"pointer":"/paths/~1users~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1users~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `manager` (User) - Retrieves the user's manager. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `role` (Role) - Retrieves the user's account role. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user's proficiency level (for skills which can be assigned proficiency levels).\n- `skills` (Skill) - Retrieves the user's skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.\n- `work_samples` (WorkSample) - Retrieves the user's portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_365","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1users~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_367"}},"schemaId":"schema_367","pointer":"/paths/~1users~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_365","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_367"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/users/{id}","href":"users/update user","openApiOperationId":"Update User","summary":"Updating an existing User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_367","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_367"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users/{id}"},{"label":"Fetch My Work Capacity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/get my work capacity","routeSlug":"/kantata/specification/users/get my work capacity","metadata":{"seo":{"title":"Fetch My Work Capacity","description":"This endpoint returns a summary of a user's work capacity for a provided range of dates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get My Work Capacity","name":"Fetch My Work Capacity","isWebhook":false,"pointer":"/paths/~1users~1{id}~1capacity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch My Work Capacity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns a summary of a user's work capacity for a provided range of dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1users~1{id}~1capacity/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"end_date","in":"query","schemaId":"schema_368","description":"The end date for calculating my work capacity in YYYY-MM-DD format (e.g. 2016-01-01). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.","required":true},{"name":"start_date","in":"query","schemaId":"schema_368","description":"The start date for calculating my work capacity in YYYY-MM-DD format (e.g. 2015-12-16). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.","required":true},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `manager` (User) - Retrieves the user's manager. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `role` (Role) - Retrieves the user's account role. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user's proficiency level (for skills which can be assigned proficiency levels).\n- `skills` (Skill) - Retrieves the user's skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.\n- `work_samples` (WorkSample) - Retrieves the user's portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_365","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1users~1{id}~1capacity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{id}/capacity","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"end_date","in":"query","required":true,"schemaId":"schema_368"},{"name":"start_date","in":"query","required":true,"schemaId":"schema_368"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_365","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/users/{id}/capacity","href":"users/get my work capacity","openApiOperationId":"Get My Work Capacity","summary":"Fetch My Work Capacity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Users have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users~1{id}~1capacity/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users/{id}/capacity"},{"label":"Reset Profile Photo","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/reset user profile photo","routeSlug":"/kantata/specification/users/reset user profile photo","metadata":{"seo":{"title":"Reset Profile Photo","description":"Delete the profile photo for the specified user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Reset User Profile Photo","name":"Reset Profile Photo","isWebhook":false,"pointer":"/paths/~1users~1{id}~1profile_photo/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset Profile Photo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete the profile photo for the specified user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1users~1{id}~1profile_photo/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/users/{id}/profile_photo","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/users/{id}/profile_photo","href":"users/reset user profile photo","openApiOperationId":"Reset User Profile Photo","summary":"Reset Profile Photo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"User has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users~1{id}~1profile_photo/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users/{id}/profile_photo"},{"label":"Update Profile Photo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/users/update user profile photo","routeSlug":"/kantata/specification/users/update user profile photo","metadata":{"seo":{"title":"Update Profile Photo","description":"Update the profile photo for the specified user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update User Profile Photo","name":"Update Profile Photo","isWebhook":false,"pointer":"/paths/~1users~1{id}~1profile_photo/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Profile Photo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the profile photo for the specified user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1users~1{id}~1profile_photo/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_membership` (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include `account_membership_id`, which references the data in the `account_memberships` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `manager` (User) - Retrieves the user's manager. The response will include `manager_id`, which references the data in the `users` top-level key.\n- `role` (Role) - Retrieves the user's account role. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `skill_memberships` (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include `skill_membership_ids`, which references the data in the `skill_memberships` top-level key. The `skill_memberships` data will include the user's proficiency level (for skills which can be assigned proficiency levels).\n- `skills` (Skill) - Retrieves the user's skills. The response will include `skill_ids`, which references the data in the `skills` top-level key. The `skills` data will include the skill description and category ID.\n- `work_samples` (WorkSample) - Retrieves the user's portfolio items. The response will include `work_sample_ids`, which references the data in the `work_samples` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_365","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1users~1{id}~1profile_photo/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_370"}},"schemaId":"schema_370","pointer":"/paths/~1users~1{id}~1profile_photo/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{id}/profile_photo","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_365","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_370"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/users/{id}/profile_photo","href":"users/update user profile photo","openApiOperationId":"Update User Profile Photo","summary":"Update Profile Photo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_370","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_370"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1users~1{id}~1profile_photo/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/users/{id}/profile_photo"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"Users represent the individuals that are participating in Kantata OX projects . User objects are often returned as\nnested JSON objects within other returned items such as posts or tasks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users","summary":"Fetching visible users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get users","deprecated":false},{"title":"/users/me","summary":"Fetch your own data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get my user data","deprecated":false},{"title":"/users/{id}","summary":"Fetching a single User","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get user","deprecated":false},{"title":"/users/{id}","summary":"Updating an existing User","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/update user","deprecated":false},{"title":"/users/{id}/capacity","summary":"Fetch My Work Capacity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get my work capacity","deprecated":false},{"title":"/users/{id}/profile_photo","summary":"Reset Profile Photo","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/reset user profile photo","deprecated":false},{"title":"/users/{id}/profile_photo","summary":"Update Profile Photo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/update user profile photo","deprecated":false}]}]}]}]}},{"type":"separator","label":"Posts & Replies","content":null},{"type":"group","label":"Attachments","link":"/kantata/specification/attachments","routeSlug":"/kantata/specification/attachments","items":[{"label":"Creating a new Attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/attachments/create attachment","routeSlug":"/kantata/specification/attachments/create attachment","metadata":{"seo":{"title":"Creating a new Attachment","description":"There are two different ways to upload file attachments. Direct CDN upload, or Kantata OX server upload."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Attachment","name":"Creating a new Attachment","isWebhook":false,"pointer":"/paths/~1attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two different ways to upload file attachments. Direct CDN upload, or Kantata OX server upload."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"attachments/create attachment/request/attachments/create attachment/request/direct-cdn-upload","deepLinkHash":"/attachments/create attachment#attachments/create attachment/request/attachments/create attachment/request/direct-cdn-upload"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct CDN Upload"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploading directly to the CDN is a three step process but allows for faster uploading, significantly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"larger attachments, and more accurate upload progress information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieving upload credentials has two required fields, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must include two attributes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required) must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"post_attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required) is the filename of the file to be uploaded."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file name must not contain spaces or special characters other than an underscore (\"_\") or a hyphen (\"-\"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"otherwise the file upload will fail."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After successfully creating an attachment, an upload url and credentials will be returned in JSON format"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with an HTTP 200 status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --form \"direct=true\" --form \"attachment[filename]=attachment.doc\"\n--form \"attachment[type]=post_attachment\" \"https://api.mavenlink.com/api/v1/attachments.json\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --form \"direct=true\" --form \"attachment[filename]=attachment.doc\"\n--form \"attachment[type]=post_attachment\" \"https://api.mavenlink.com/api/v1/attachments.json\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response JSON will then contain the information to upload the file:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"id\": 2,\n \"action\": \"[upload url]\",\n \"fields\":{\n \"utf8\": \"✓\",\n \"key\": \" ... \",\n \"Content-Disposition\": \"attachment; filename=\"attachment.doc\"; filename*=UTF-8''attachment.doc\",\n \"success_action_status\": 201,\n \"AWSAccessKeyId\": \" ... \",\n \"acl\": \"private\",\n \"policy\": \" ... \",\n \"signature\": \" ... \"\n }\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"id\": 2,\n \"action\": \"[upload url]\",\n \"fields\":{\n \"utf8\": \"✓\",\n \"key\": \" ... \",\n \"Content-Disposition\": \"attachment; filename=\"attachment.doc\"; filename*=UTF-8''attachment.doc\",\n \"success_action_status\": 201,\n \"AWSAccessKeyId\": \" ... \",\n \"acl\": \"private\",\n \"policy\": \" ... \",\n \"signature\": \" ... \"\n }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A second POST request can then be made to the provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the field values"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned in the JSON response, in addition to the file data. The AWSAccessKeyId field value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is only active for 5 seconds, so these consecutive calls are meant to be made in quick succession via a script."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$file"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", variables in the request that start with $ are the values represented by the \" ... \" blanks in the JSON response."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \"[upload url]\" -H 'cache-control: no-cache' --form 'AWSAccessKeyId='$awsKey --form 'Content-Disposition=\"attachment; filename=\"$file\"; filename*=UTF-8''''''$file\"' --form 'x-amz-server-side-encryption=AES256' --form 'key='$key --form 'policy='$policy --form 'signature='$sig --form 'acl=private' --form 'success_action_status=201' --form 'utf8=✓' --form 'file=@'$file\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \"[upload url]\" -H 'cache-control: no-cache' --form 'AWSAccessKeyId='$awsKey --form 'Content-Disposition=\"attachment; filename=\"$file\"; filename*=UTF-8''''''$file\"' --form 'x-amz-server-side-encryption=AES256' --form 'key='$key --form 'policy='$policy --form 'signature='$sig --form 'acl=private' --form 'success_action_status=201' --form 'utf8=✓' --form 'file=@'$file\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finally, once the upload has completed successfully, a 'sync' request (specified below) is necessary to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mark the upload as complete."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Below is a simplified example using ruby to achieve the same thing as with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" commands above:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"#!/usr/bin/env ruby\n\nrequire 'net/https'\nrequire \"uri\"\nrequire 'json'\n\nTOKEN=\"Bearer \"\nATTACHMENTS_ENDPOINT=\"https://api.mavenlink.com/api/v1/attachments.json\"\nBOUNDARY = \"AaB03x\" # Make sure it is not present in the file you're uploading.\n\nfile = ARGV[0]\nfilename = File.basename(file)\n\nuri = URI.parse(ATTACHMENTS_ENDPOINT)\nhttp = Net::HTTP.new(uri.host, uri.port)\nhttp.use_ssl = true\nrequest = Net::HTTP::Post.new(uri.request_uri)\nrequest['Authorization'] = TOKEN\nrequest.set_form_data(first_request_params)\nresponse = http.request(request)\nfirst_response = JSON.parse(response.body)\n\n# for the second request we manually build the request body\npost_body = []\n\nsecond_request_params = first_response[\"fields\"].merge({ \"file\" => File.open(file) })\nsecond_request_params.each do |k,v|\n post_body << \"--#{BOUNDARY}\\r\\n\"\n if v.is_a?(IO)\n post_body << \"Content-Disposition: form-data; name=\"#{k}\"; filename=\"#{filename}\"\\r\\n\"\n post_body << \"\\r\\n\"\n post_body << File.read(file)\n post_body << \"\\r\\n\"\n else\n post_body << \"Content-Disposition: form-data; name=\"#{k}\"\\r\\n\\r\\n\"\n post_body << v.to_s + \"\\r\\n\"\n end\nend\n\npost_body << \"--#{BOUNDARY}--\\r\\n\"\n\nuri = URI.parse(first_response[\"action\"])\nhttp = Net::HTTP.new(uri.host, uri.port)\nhttp.use_ssl = true\nrequest = Net::HTTP::Post.new(uri.request_uri)\nrequest.body = post_body.join\nrequest[\"Content-Type\"] = \"multipart/form-data, boundary=#{BOUNDARY}\"\nresponse = http.request(request)\n\nexit(response.code == second_request_params[\"success_action_status\"].to_s)\n","language":"ruby"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"#!/usr/bin/env ruby\n\nrequire 'net/https'\nrequire \"uri\"\nrequire 'json'\n\nTOKEN=\"Bearer \"\nATTACHMENTS_ENDPOINT=\"https://api.mavenlink.com/api/v1/attachments.json\"\nBOUNDARY = \"AaB03x\" # Make sure it is not present in the file you're uploading.\n\nfile = ARGV[0]\nfilename = File.basename(file)\n\nuri = URI.parse(ATTACHMENTS_ENDPOINT)\nhttp = Net::HTTP.new(uri.host, uri.port)\nhttp.use_ssl = true\nrequest = Net::HTTP::Post.new(uri.request_uri)\nrequest['Authorization'] = TOKEN\nrequest.set_form_data(first_request_params)\nresponse = http.request(request)\nfirst_response = JSON.parse(response.body)\n\n# for the second request we manually build the request body\npost_body = []\n\nsecond_request_params = first_response[\"fields\"].merge({ \"file\" => File.open(file) })\nsecond_request_params.each do |k,v|\n post_body << \"--#{BOUNDARY}\\r\\n\"\n if v.is_a?(IO)\n post_body << \"Content-Disposition: form-data; name=\"#{k}\"; filename=\"#{filename}\"\\r\\n\"\n post_body << \"\\r\\n\"\n post_body << File.read(file)\n post_body << \"\\r\\n\"\n else\n post_body << \"Content-Disposition: form-data; name=\"#{k}\"\\r\\n\\r\\n\"\n post_body << v.to_s + \"\\r\\n\"\n end\nend\n\npost_body << \"--#{BOUNDARY}--\\r\\n\"\n\nuri = URI.parse(first_response[\"action\"])\nhttp = Net::HTTP.new(uri.host, uri.port)\nhttp.use_ssl = true\nrequest = Net::HTTP::Post.new(uri.request_uri)\nrequest.body = post_body.join\nrequest[\"Content-Type\"] = \"multipart/form-data, boundary=#{BOUNDARY}\"\nresponse = http.request(request)\n\nexit(response.code == second_request_params[\"success_action_status\"].to_s)\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"attachments/create attachment/request/attachments/create attachment/request/syncing-a-created-attachment","deepLinkHash":"/attachments/create attachment#attachments/create attachment/request/attachments/create attachment/request/syncing-a-created-attachment"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Syncing a created Attachment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Syncing marks an upload as complete, and verifies its existence on the CDN."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sync request can be made as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X PUT \"https://api.mavenlink.com/api/v1/attachments/2/sync.json\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X PUT \"https://api.mavenlink.com/api/v1/attachments/2/sync.json\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"attachments/create attachment/request/attachments/create attachment/request/kantata-ox-server-upload","deepLinkHash":"/attachments/create attachment#attachments/create attachment/request/attachments/create attachment/request/kantata-ox-server-upload"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kantata OX Server Upload"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For small attachments (< 10MB), you may upload to our servers and skip the 3-step direct CDN upload process."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Doing so requires one field, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with two required attributes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required) must be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"post_attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required) is the multipart/form-data encoded file contents."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After successfully creating an attachment its metadata will be returned in JSON format with an HTTP 200"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status code. To upload a file using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" utility, you would run a command like this one:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --form \"attachment[data]=@test.rb\" --form \"attachment[type]=post_attachment\" \"https://api.mavenlink.com/api/v1/attachments.json\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --form \"attachment[data]=@test.rb\" --form \"attachment[type]=post_attachment\" \"https://api.mavenlink.com/api/v1/attachments.json\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Attachment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_404"}},"schemaId":"schema_404","pointer":"/paths/~1attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/attachments","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_404"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/attachments","href":"attachments/create attachment","openApiOperationId":"Create Attachment","summary":"Creating a new Attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_404","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_404"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}},"schemaId":"schema_405"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_405","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/attachments"},{"label":"Updating an existing Attachment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/attachments/update attachment","routeSlug":"/kantata/specification/attachments/update attachment","metadata":{"seo":{"title":"Updating an existing Attachment","description":"This endpoint returns structured Attachment objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the attachments top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Attachment","name":"Updating an existing Attachment","isWebhook":false,"pointer":"/paths/~1attachments~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Attachment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1attachments~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"schemaId":"schema_406","pointer":"/paths/~1attachments~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/attachments/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_406"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/attachments/{id}","href":"attachments/update attachment","openApiOperationId":"Update Attachment","summary":"Updating an existing Attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}},"schemaId":"schema_405"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1attachments~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_405","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/attachments/{id}"},{"label":"Deleting an existing Attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/attachments/delete attachment","routeSlug":"/kantata/specification/attachments/delete attachment","metadata":{"seo":{"title":"Deleting an existing Attachment","description":"Destroys an attachment from its subject object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Attachment","name":"Deleting an existing Attachment","isWebhook":false,"pointer":"/paths/~1attachments~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destroys an attachment from its subject object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1attachments~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/attachments/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/attachments/{id}","href":"attachments/delete attachment","openApiOperationId":"Delete Attachment","summary":"Deleting an existing Attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Attachment has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1attachments~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/attachments/{id}"},{"label":"Sync a created attachment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/attachments/sync attachment","routeSlug":"/kantata/specification/attachments/sync attachment","metadata":{"seo":{"title":"Sync a created attachment","description":"Marks an upload as complete, and verifies its existence on the CDN."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Sync Attachment","name":"Sync a created attachment","isWebhook":false,"pointer":"/paths/~1attachments~1{id}~1sync/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync a created attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marks an upload as complete, and verifies its existence on the CDN."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Attachment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1attachments~1{id}~1sync/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/attachments/{id}/sync","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/attachments/{id}/sync","href":"attachments/sync attachment","openApiOperationId":"Sync Attachment","summary":"Sync a created attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}},"schemaId":"schema_405"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1attachments~1{id}~1sync/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_405","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/attachments/{id}/sync"}],"content":{"contentType":"group","meta":{"name":"Attachments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attachments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An Attachment is a file asset that is attached to another Kantata OX object. Depending on the type of object,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the file is used or displayed in different ways. The objects that Attachments can be attached to are:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Post and Expense."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create an Expense or Post with an Attachment, use the resulting attachment_id from the Attachment creation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request in the parameters of the Expense or Post creation request."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/attachments","summary":"Creating a new Attachment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/attachments/create attachment","deprecated":false},{"title":"/attachments/{id}","summary":"Updating an existing Attachment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/attachments/update attachment","deprecated":false},{"title":"/attachments/{id}","summary":"Deleting an existing Attachment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/attachments/delete attachment","deprecated":false},{"title":"/attachments/{id}/sync","summary":"Sync a created attachment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/attachments/sync attachment","deprecated":false}]}]}]}]}},{"type":"group","label":"Posts","link":"/kantata/specification/posts","routeSlug":"/kantata/specification/posts","items":[{"label":"Fetching a list of Posts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/posts/get posts","routeSlug":"/kantata/specification/posts/get posts","metadata":{"seo":{"title":"Fetching a list of Posts","description":"This endpoint returns structured Post objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the posts top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Posts","name":"Fetching a list of Posts","isWebhook":false,"pointer":"/paths/~1posts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Posts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Post objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"posts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"from_archived_workspaces","in":"query","schemaId":"schema_351","description":"Also includes posts from archived projects."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `attachments` (Attachments::PostAttachment) - Any attachments associated to the post.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `google_documents` (GoogleDocument) - The post's Google document objects, available in `google_document_ids`; returned in the `google_documents` top-level key.\n- `newest_reply` (Post) - The most recent reply to the post.\n- `newest_reply_user` (User) - The user who made the most recent reply to the post.\n- `recipients` (User) - On private posts, the `recipient_ids` array contains the IDs of recipients, returned in the `users` top-level key.\n- `replies` (Post) - Replies made to this post, returned in the `posts` top-level key. Posts will contain a `reply_ids` array.\n- `story` (Story) - The task (if any) to which the post is linked.\n- `subject` (polymorphic) - When you include this association, posts that are replies will have a `subject_id` key. This references\ntheir parent post in the `posts` top-level key.\n- `user` (User) - The user who created the post.\n- `workspace` (Workspace) - The project to which this post belongs."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_456","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `newest_reply_at:asc` and `newest_reply_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"parents_only","in":"query","schemaId":"schema_351","description":"Results will only include parent posts (without including replies by themselves)."},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"private","in":"query","schemaId":"schema_305","description":"Only includes posts that are private to the current user."},{"name":"search","in":"query","schemaId":"schema_304"},{"name":"story_id","in":"query","schemaId":"schema_313","description":"Only includes posts from the specified task."},{"name":"story_ids","in":"query","schemaId":"schema_304","description":"Filter for posts linked to specific tasks. Provide a comma-separated list of task IDs."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Only includes posts from the specified project."}],"pointer":"/paths/~1posts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/posts","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"from_archived_workspaces","in":"query","schemaId":"schema_351"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_456"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"parents_only","in":"query","schemaId":"schema_351"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"private","in":"query","schemaId":"schema_305"},{"name":"search","in":"query","schemaId":"schema_304"},{"name":"story_id","in":"query","schemaId":"schema_313"},{"name":"story_ids","in":"query","schemaId":"schema_304"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/posts","href":"posts/get posts","openApiOperationId":"Get Posts","summary":"Fetching a list of Posts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Posts have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_457"}},"schemaId":"schema_457"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1posts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_457","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_457"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/posts"},{"label":"Creating a new Post","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/posts/create post","routeSlug":"/kantata/specification/posts/create post","metadata":{"seo":{"title":"Creating a new Post","description":"Posts to the Activity Feed of a workspace (project)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Post","name":"Creating a new Post","isWebhook":false,"pointer":"/paths/~1posts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Posts to the Activity Feed of a workspace (project)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"posts\": [\n {\n \"workspace_id\": 123,\n \"message\": \"Post\"\n },\n {\n \"workspace_id\": 456,\n \"message\": \"Post\"\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"posts\": [\n {\n \"workspace_id\": 123,\n \"message\": \"Post\"\n },\n {\n \"workspace_id\": 456,\n \"message\": \"Post\"\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Post objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"posts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `attachments` (Attachments::PostAttachment) - Any attachments associated to the post.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `google_documents` (GoogleDocument) - The post's Google document objects, available in `google_document_ids`; returned in the `google_documents` top-level key.\n- `newest_reply` (Post) - The most recent reply to the post.\n- `newest_reply_user` (User) - The user who made the most recent reply to the post.\n- `recipients` (User) - On private posts, the `recipient_ids` array contains the IDs of recipients, returned in the `users` top-level key.\n- `replies` (Post) - Replies made to this post, returned in the `posts` top-level key. Posts will contain a `reply_ids` array.\n- `story` (Story) - The task (if any) to which the post is linked.\n- `subject` (polymorphic) - When you include this association, posts that are replies will have a `subject_id` key. This references\ntheir parent post in the `posts` top-level key.\n- `user` (User) - The user who created the post.\n- `workspace` (Workspace) - The project to which this post belongs."}],"pointer":"/paths/~1posts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_458"}},"schemaId":"schema_458","pointer":"/paths/~1posts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/posts","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_458"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/posts","href":"posts/create post","openApiOperationId":"Create Post","summary":"Creating a new Post"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_458","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_458"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Post has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_457"}},"schemaId":"schema_457"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1posts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_457","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_457"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/posts"},{"label":"Fetching a single Post","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/posts/get post","routeSlug":"/kantata/specification/posts/get post","metadata":{"seo":{"title":"Fetching a single Post","description":"By default, you won't receive Posts from archived workspaces (and will receive a 404 statuson the \"show\" route) unless you provide the from_archived_workspaces:true filter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Post","name":"Fetching a single Post","isWebhook":false,"pointer":"/paths/~1posts~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, you won't receive Posts from archived workspaces (and will receive a 404 status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the \"show\" route) unless you provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from_archived_workspaces:true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Post objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"posts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1posts~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `attachments` (Attachments::PostAttachment) - Any attachments associated to the post.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `google_documents` (GoogleDocument) - The post's Google document objects, available in `google_document_ids`; returned in the `google_documents` top-level key.\n- `newest_reply` (Post) - The most recent reply to the post.\n- `newest_reply_user` (User) - The user who made the most recent reply to the post.\n- `recipients` (User) - On private posts, the `recipient_ids` array contains the IDs of recipients, returned in the `users` top-level key.\n- `replies` (Post) - Replies made to this post, returned in the `posts` top-level key. Posts will contain a `reply_ids` array.\n- `story` (Story) - The task (if any) to which the post is linked.\n- `subject` (polymorphic) - When you include this association, posts that are replies will have a `subject_id` key. This references\ntheir parent post in the `posts` top-level key.\n- `user` (User) - The user who created the post.\n- `workspace` (Workspace) - The project to which this post belongs."}],"pointer":"/paths/~1posts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/posts/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/posts/{id}","href":"posts/get post","openApiOperationId":"Get Post","summary":"Fetching a single Post"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Post has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_457"}},"schemaId":"schema_457"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1posts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_457","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_457"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/posts/{id}"},{"label":"Updating an existing Post","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/posts/update post","routeSlug":"/kantata/specification/posts/update post","metadata":{"seo":{"title":"Updating an existing Post","description":"This endpoint returns structured Post objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the posts top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Post","name":"Updating an existing Post","isWebhook":false,"pointer":"/paths/~1posts~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Post objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"posts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1posts~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `attachments` (Attachments::PostAttachment) - Any attachments associated to the post.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `google_documents` (GoogleDocument) - The post's Google document objects, available in `google_document_ids`; returned in the `google_documents` top-level key.\n- `newest_reply` (Post) - The most recent reply to the post.\n- `newest_reply_user` (User) - The user who made the most recent reply to the post.\n- `recipients` (User) - On private posts, the `recipient_ids` array contains the IDs of recipients, returned in the `users` top-level key.\n- `replies` (Post) - Replies made to this post, returned in the `posts` top-level key. Posts will contain a `reply_ids` array.\n- `story` (Story) - The task (if any) to which the post is linked.\n- `subject` (polymorphic) - When you include this association, posts that are replies will have a `subject_id` key. This references\ntheir parent post in the `posts` top-level key.\n- `user` (User) - The user who created the post.\n- `workspace` (Workspace) - The project to which this post belongs."}],"pointer":"/paths/~1posts~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","pointer":"/paths/~1posts~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/posts/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_459"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/posts/{id}","href":"posts/update post","openApiOperationId":"Update Post","summary":"Updating an existing Post"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_459"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Post has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_457"}},"schemaId":"schema_457"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1posts~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_457","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_457"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/posts/{id}"},{"label":"Deleting an existing Post","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/posts/delete post","routeSlug":"/kantata/specification/posts/delete post","metadata":{"seo":{"title":"Deleting an existing Post","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Post","name":"Deleting an existing Post","isWebhook":false,"pointer":"/paths/~1posts~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1posts~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/posts/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/posts/{id}","href":"posts/delete post","openApiOperationId":"Delete Post","summary":"Deleting an existing Post"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Post has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1posts~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/posts/{id}"}],"content":{"contentType":"group","meta":{"name":"Posts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Posts","showPageActions":true},{"nodeType":"markdoc","content":"A Post represents a message written by participants in a project that appears in the project. Replies are only\nincluded if they are directly related to a post. Replies to events, such as Change Orders or Story Created\nEvents, are not included."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/posts","summary":"Fetching a list of Posts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/posts/get posts","deprecated":false},{"title":"/posts","summary":"Creating a new Post","prefix":{"name":"post","color":"post"},"badges":[],"link":"/posts/create post","deprecated":false},{"title":"/posts/{id}","summary":"Fetching a single Post","prefix":{"name":"get","color":"get"},"badges":[],"link":"/posts/get post","deprecated":false},{"title":"/posts/{id}","summary":"Updating an existing Post","prefix":{"name":"put","color":"put"},"badges":[],"link":"/posts/update post","deprecated":false},{"title":"/posts/{id}","summary":"Deleting an existing Post","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/posts/delete post","deprecated":false}]}]}]}]}},{"type":"group","label":"User File Associations","link":"/kantata/specification/user-file-associations","routeSlug":"/kantata/specification/user-file-associations","items":[{"label":"Fetching a list of User File Associations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/user-file-associations/get user file associations","routeSlug":"/kantata/specification/user-file-associations/get user file associations","metadata":{"seo":{"title":"Fetching a list of User File Associations","description":"This endpoint returns structured User File Association objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the user_file_associations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get User File Associations","name":"Fetching a list of User File Associations","isWebhook":false,"pointer":"/paths/~1user_file_associations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of User File Associations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured User File Association objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_file_associations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filename","in":"query","schemaId":"schema_304","description":"Only includes file associations with matching filenames."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `asset_object` (polymorphic) - When included, the polymorphic `asset_object_ref` struct will reference the attachment or\nGoogle document for which the user file association belongs. This will be a a two-key JSON\nobject with \"ID\" and \"key\", where the \"key\" will be \"attachments\" or \"google_documents\".\n- `post` (Post) - The post to which the user file association belongs.\n- `workspace` (Workspace) - References the project to which the user file association belongs."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Only includes file associations from the specified project."}],"pointer":"/paths/~1user_file_associations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user_file_associations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"filename","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/user_file_associations","href":"user-file-associations/get user file associations","openApiOperationId":"Get User File Associations","summary":"Fetching a list of User File Associations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of User File Associations have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_460"}},"schemaId":"schema_460"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1user_file_associations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_460","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_460"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/user_file_associations"}],"content":{"contentType":"group","meta":{"name":"User File Associations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User File Associations","showPageActions":true},{"nodeType":"markdoc","content":"User File Associations in Kantata OX act as a join object between Users, Workspaces, and\nAttachments / Google Documents."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/user_file_associations","summary":"Fetching a list of User File Associations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-file-associations/get user file associations","deprecated":false}]}]}]}]}},{"type":"separator","label":"Project Snapshots","content":null},{"type":"group","label":"Project Snapshots","link":"/kantata/specification/project-snapshots","routeSlug":"/kantata/specification/project-snapshots","items":[{"label":"Fetching a list of Project Snapshots","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-snapshots/get project snapshots","routeSlug":"/kantata/specification/project-snapshots/get project snapshots","metadata":{"seo":{"title":"Fetching a list of Project Snapshots","description":"Gets a list of Project Snapshots. You can only see snapshots for projects where you have the Edit Financials project permission or higher."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Project Snapshots","name":"Fetching a list of Project Snapshots","isWebhook":false,"pointer":"/paths/~1project_snapshots/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Project Snapshots","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a list of Project Snapshots. You can only see snapshots for projects where you have the Edit Financials project permission or higher."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Snapshots objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_snapshots"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"by_title","in":"query","schemaId":"schema_304","description":"Filter for snapshots with a title that match the specified search term. This filter is not case sensitive."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_snapshot_assignments` (Project::Snapshots::Models::ProjectSnapshotAssignment) - Retrieves task assignments saved in snapshots. The response will include `project_snapshot_assignment_ids`, which references the data in the `project_snapshot_assignments` top-level key.\n- `project_snapshot_custom_field_values` (Project::Snapshots::Models::ProjectSnapshotCustomFieldValue) - Retrieves project custom fields saved in snapshots. The response will include `project_snapshot_custom_field_value_ids`, which references the data in the `project_snapshot_custom_field_values` top-level key.\n- `project_snapshot_resources` (Project::Snapshots::Models::ProjectSnapshotResource) - Retrieves the resources saved in snapshots. The response will include `project_snapshot_resource_ids`, which references the data in the `project_snapshot_resources` top-level key.\n- `project_snapshot_task_custom_field_values` (Project::Snapshots::Models::ProjectSnapshotCustomFieldValue) - Retrieves task custom fields saved in snapshots. The response will include `project_snapshot_task_custom_field_value_ids`, which references the data in the `project_snapshot_custom_field_values` top-level key.\n- `project_snapshot_tasks` (Project::Snapshots::Models::ProjectSnapshotTask) - Retrieves the tasks saved in snapshots. The response will include `project_snapshot_task_ids`, which references the data in the `project_snapshot_tasks` top-level key."},{"name":"is_baseline","in":"query","schemaId":"schema_305","description":"Return only snapshots that are marked as the baseline."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Filter for snapshots by workspace ID."}],"pointer":"/paths/~1project_snapshots/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project_snapshots","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"by_title","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"is_baseline","in":"query","schemaId":"schema_305"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_snapshots","href":"project-snapshots/get project snapshots","openApiOperationId":"Get Project Snapshots","summary":"Fetching a list of Project Snapshots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Project Snapshots have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_461"}},"schemaId":"schema_461"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_snapshots/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_461","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_461"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_snapshots"},{"label":"Creating a Project Snapshot","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-snapshots/create project snapshot","routeSlug":"/kantata/specification/project-snapshots/create project snapshot","metadata":{"seo":{"title":"Creating a Project Snapshot","description":"Creates a Project Snapshot. You must have the Edit Financials project permission or higher to create a project snapshot."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Project Snapshot","name":"Creating a Project Snapshot","isWebhook":false,"pointer":"/paths/~1project_snapshots/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a Project Snapshot","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a Project Snapshot. You must have the Edit Financials project permission or higher to create a project snapshot."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has its own rate limit. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/9698066628123"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Snapshots objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_snapshots"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_snapshot_assignments` (Project::Snapshots::Models::ProjectSnapshotAssignment) - Retrieves task assignments saved in snapshots. The response will include `project_snapshot_assignment_ids`, which references the data in the `project_snapshot_assignments` top-level key.\n- `project_snapshot_custom_field_values` (Project::Snapshots::Models::ProjectSnapshotCustomFieldValue) - Retrieves project custom fields saved in snapshots. The response will include `project_snapshot_custom_field_value_ids`, which references the data in the `project_snapshot_custom_field_values` top-level key.\n- `project_snapshot_resources` (Project::Snapshots::Models::ProjectSnapshotResource) - Retrieves the resources saved in snapshots. The response will include `project_snapshot_resource_ids`, which references the data in the `project_snapshot_resources` top-level key.\n- `project_snapshot_task_custom_field_values` (Project::Snapshots::Models::ProjectSnapshotCustomFieldValue) - Retrieves task custom fields saved in snapshots. The response will include `project_snapshot_task_custom_field_value_ids`, which references the data in the `project_snapshot_custom_field_values` top-level key.\n- `project_snapshot_tasks` (Project::Snapshots::Models::ProjectSnapshotTask) - Retrieves the tasks saved in snapshots. The response will include `project_snapshot_task_ids`, which references the data in the `project_snapshot_tasks` top-level key."}],"pointer":"/paths/~1project_snapshots/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1project_snapshots/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/project_snapshots","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_snapshots","href":"project-snapshots/create project snapshot","openApiOperationId":"Create Project Snapshot","summary":"Creating a Project Snapshot"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project Snapshots has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_461"}},"schemaId":"schema_461"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_snapshots/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_461","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_461"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_snapshots"},{"label":"Updating a Project Snapshot","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-snapshots/update project snapshot","routeSlug":"/kantata/specification/project-snapshots/update project snapshot","metadata":{"seo":{"title":"Updating a Project Snapshot","description":"Updates the metadata of a Project Snapshot."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Project Snapshot","name":"Updating a Project Snapshot","isWebhook":false,"pointer":"/paths/~1project_snapshots~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating a Project Snapshot","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the metadata of a Project Snapshot."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Snapshots objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_snapshots"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1project_snapshots~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_snapshot_assignments` (Project::Snapshots::Models::ProjectSnapshotAssignment) - Retrieves task assignments saved in snapshots. The response will include `project_snapshot_assignment_ids`, which references the data in the `project_snapshot_assignments` top-level key.\n- `project_snapshot_custom_field_values` (Project::Snapshots::Models::ProjectSnapshotCustomFieldValue) - Retrieves project custom fields saved in snapshots. The response will include `project_snapshot_custom_field_value_ids`, which references the data in the `project_snapshot_custom_field_values` top-level key.\n- `project_snapshot_resources` (Project::Snapshots::Models::ProjectSnapshotResource) - Retrieves the resources saved in snapshots. The response will include `project_snapshot_resource_ids`, which references the data in the `project_snapshot_resources` top-level key.\n- `project_snapshot_task_custom_field_values` (Project::Snapshots::Models::ProjectSnapshotCustomFieldValue) - Retrieves task custom fields saved in snapshots. The response will include `project_snapshot_task_custom_field_value_ids`, which references the data in the `project_snapshot_custom_field_values` top-level key.\n- `project_snapshot_tasks` (Project::Snapshots::Models::ProjectSnapshotTask) - Retrieves the tasks saved in snapshots. The response will include `project_snapshot_task_ids`, which references the data in the `project_snapshot_tasks` top-level key."}],"pointer":"/paths/~1project_snapshots~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_463"}},"schemaId":"schema_463","pointer":"/paths/~1project_snapshots~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/project_snapshots/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_463"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_snapshots/{id}","href":"project-snapshots/update project snapshot","openApiOperationId":"Update Project Snapshot","summary":"Updating a Project Snapshot"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_463","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_463"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project Snapshots has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_461"}},"schemaId":"schema_461"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_snapshots~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_461","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_461"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_snapshots/{id}"}],"content":{"contentType":"group","meta":{"name":"Project Snapshots"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project Snapshots","showPageActions":true},{"nodeType":"markdoc","content":"Project snapshots capture the state of a project at a specific point in time. Snapshots are useful for gaining a historical perspective on a project, and for comparing the current state of a project to a previous state.\n\nProject financials, tasks, and resources are all captured in a snapshot, as well as project and task custom field values.\n\nTo use these endpoints, you must have the Edit Financials permission or higher in a project."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/project_snapshots","summary":"Fetching a list of Project Snapshots","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-snapshots/get project snapshots","deprecated":false},{"title":"/project_snapshots","summary":"Creating a Project Snapshot","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-snapshots/create project snapshot","deprecated":false},{"title":"/project_snapshots/{id}","summary":"Updating a Project Snapshot","prefix":{"name":"put","color":"put"},"badges":[],"link":"/project-snapshots/update project snapshot","deprecated":false}]}]}]}]}},{"type":"separator","label":"Project Templates","content":null},{"type":"group","label":"Project Template Additional Tabs","link":"/kantata/specification/project-template-additional-tabs","routeSlug":"/kantata/specification/project-template-additional-tabs","items":[{"label":"Fetching a list of Project Template Additional Tabs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-additional-tabs/get project template additional tabs","routeSlug":"/kantata/specification/project-template-additional-tabs/get project template additional tabs","metadata":{"seo":{"title":"Fetching a list of Project Template Additional Tabs","description":"This endpoint returns structured Project Template Additional Tab objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the project_template_additional_tabs top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Project Template Additional Tabs","name":"Fetching a list of Project Template Additional Tabs","isWebhook":false,"pointer":"/paths/~1project_template_additional_tabs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Project Template Additional Tabs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template Additional Tab objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_template_additional_tabs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `updated_at:asc` and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"project_template_id","in":"query","schemaId":"schema_313","description":"Filter by project template ID."}],"pointer":"/paths/~1project_template_additional_tabs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project_template_additional_tabs","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"project_template_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_template_additional_tabs","href":"project-template-additional-tabs/get project template additional tabs","openApiOperationId":"Get Project Template Additional Tabs","summary":"Fetching a list of Project Template Additional Tabs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Project Template Additional Tabs have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_464"}},"schemaId":"schema_464"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_additional_tabs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_464","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_464"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_additional_tabs"},{"label":"Creating a new Project Template Additional Tab","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-additional-tabs/create project template additional tab","routeSlug":"/kantata/specification/project-template-additional-tabs/create project template additional tab","metadata":{"seo":{"title":"Creating a new Project Template Additional Tab","description":"Adds an additional tab to a project template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Project Template Additional Tab","name":"Creating a new Project Template Additional Tab","isWebhook":false,"pointer":"/paths/~1project_template_additional_tabs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Project Template Additional Tab","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds an additional tab to a project template."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template Additional Tab objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_template_additional_tabs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_465"}},"schemaId":"schema_465","pointer":"/paths/~1project_template_additional_tabs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/project_template_additional_tabs","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_465"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_template_additional_tabs","href":"project-template-additional-tabs/create project template additional tab","openApiOperationId":"Create Project Template Additional Tab","summary":"Creating a new Project Template Additional Tab"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_465","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_465"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project Template Additional Tab has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_464"}},"schemaId":"schema_464"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_additional_tabs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_464","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_464"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_additional_tabs"},{"label":"Deleting an existing Project Template Additional Tab","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-additional-tabs/delete project template additional tab","routeSlug":"/kantata/specification/project-template-additional-tabs/delete project template additional tab","metadata":{"seo":{"title":"Deleting an existing Project Template Additional Tab","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Project Template Additional Tab","name":"Deleting an existing Project Template Additional Tab","isWebhook":false,"pointer":"/paths/~1project_template_additional_tabs~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Project Template Additional Tab","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1project_template_additional_tabs~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/project_template_additional_tabs/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/project_template_additional_tabs/{id}","href":"project-template-additional-tabs/delete project template additional tab","openApiOperationId":"Delete Project Template Additional Tab","summary":"Deleting an existing Project Template Additional Tab"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Project Template Additional Tab has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_additional_tabs~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_additional_tabs/{id}"}],"content":{"contentType":"group","meta":{"name":"Project Template Additional Tabs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project Template Additional Tabs","showPageActions":true},{"nodeType":"markdoc","content":"Project Template Additional Tabs are additional tabs configured in a project template that are\nadded to a project when the template is applied."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/project_template_additional_tabs","summary":"Fetching a list of Project Template Additional Tabs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-template-additional-tabs/get project template additional tabs","deprecated":false},{"title":"/project_template_additional_tabs","summary":"Creating a new Project Template Additional Tab","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-template-additional-tabs/create project template additional tab","deprecated":false},{"title":"/project_template_additional_tabs/{id}","summary":"Deleting an existing Project Template Additional Tab","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/project-template-additional-tabs/delete project template additional tab","deprecated":false}]}]}]}]}},{"type":"group","label":"Project Template Assignments","link":"/kantata/specification/project-template-assignments","routeSlug":"/kantata/specification/project-template-assignments","items":[{"label":"Fetching a list of Project Template Assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-assignments/get project template assignments","routeSlug":"/kantata/specification/project-template-assignments/get project template assignments","metadata":{"seo":{"title":"Fetching a list of Project Template Assignments","description":"This endpoint returns structured Project Template Assignment objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the project_template_assignments top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Project Template Assignments","name":"Fetching a list of Project Template Assignments","isWebhook":false,"pointer":"/paths/~1project_template_assignments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Project Template Assignments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template Assignment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_template_assignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_template` (ProjectTemplate) - The project template associated with the assignment.\n- `role` (Role)."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"optional_fields","in":"query","schemaId":"schema_466","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `updated_at:asc` and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"project_template_id","in":"query","schemaId":"schema_313","description":"Limits project template assignments to a specific project template."}],"pointer":"/paths/~1project_template_assignments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project_template_assignments","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_466","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"project_template_id","in":"query","required":false,"schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_template_assignments","href":"project-template-assignments/get project template assignments","openApiOperationId":"Get Project Template Assignments","summary":"Fetching a list of Project Template Assignments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Project Template Assignments have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}},"schemaId":"schema_467"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_assignments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_467","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_assignments"},{"label":"Creating a new Project Template Assignment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-assignments/create project template assignment","routeSlug":"/kantata/specification/project-template-assignments/create project template assignment","metadata":{"seo":{"title":"Creating a new Project Template Assignment","description":"This endpoint returns structured Project Template Assignment objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the project_template_assignments top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Project Template Assignment","name":"Creating a new Project Template Assignment","isWebhook":false,"pointer":"/paths/~1project_template_assignments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Project Template Assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template Assignment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_template_assignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_template` (ProjectTemplate) - The project template associated with the assignment.\n- `role` (Role)."},{"name":"optional_fields","in":"query","schemaId":"schema_466","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1project_template_assignments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_468"}},"schemaId":"schema_468","pointer":"/paths/~1project_template_assignments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/project_template_assignments","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_466","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_468"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_template_assignments","href":"project-template-assignments/create project template assignment","openApiOperationId":"Create Project Template Assignment","summary":"Creating a new Project Template Assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_468","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_468"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project Template Assignment has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}},"schemaId":"schema_467"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_assignments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_467","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_assignments"},{"label":"Fetching a single Project Template Assignment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-assignments/get project template assignment","routeSlug":"/kantata/specification/project-template-assignments/get project template assignment","metadata":{"seo":{"title":"Fetching a single Project Template Assignment","description":"This endpoint returns structured Project Template Assignment objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the project_template_assignments top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Project Template Assignment","name":"Fetching a single Project Template Assignment","isWebhook":false,"pointer":"/paths/~1project_template_assignments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Project Template Assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template Assignment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_template_assignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1project_template_assignments~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_template` (ProjectTemplate) - The project template associated with the assignment.\n- `role` (Role)."},{"name":"optional_fields","in":"query","schemaId":"schema_466","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1project_template_assignments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project_template_assignments/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_466","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_template_assignments/{id}","href":"project-template-assignments/get project template assignment","openApiOperationId":"Get Project Template Assignment","summary":"Fetching a single Project Template Assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Project Template Assignment has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}},"schemaId":"schema_467"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_assignments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_467","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_assignments/{id}"},{"label":"Updating an existing Project Template Assignment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-assignments/update project template assignment","routeSlug":"/kantata/specification/project-template-assignments/update project template assignment","metadata":{"seo":{"title":"Updating an existing Project Template Assignment","description":"This endpoint returns structured Project Template Assignment objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the project_template_assignments top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Project Template Assignment","name":"Updating an existing Project Template Assignment","isWebhook":false,"pointer":"/paths/~1project_template_assignments~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Project Template Assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template Assignment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_template_assignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1project_template_assignments~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_template` (ProjectTemplate) - The project template associated with the assignment.\n- `role` (Role)."},{"name":"optional_fields","in":"query","schemaId":"schema_466","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1project_template_assignments~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_469"}},"schemaId":"schema_469","pointer":"/paths/~1project_template_assignments~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/project_template_assignments/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_466","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_469"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_template_assignments/{id}","href":"project-template-assignments/update project template assignment","openApiOperationId":"Update Project Template Assignment","summary":"Updating an existing Project Template Assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_469","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_469"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project Template Assignment has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}},"schemaId":"schema_467"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_assignments~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_467","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_assignments/{id}"},{"label":"Deleting an existing Project Template Assignment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-assignments/delete project template assignment","routeSlug":"/kantata/specification/project-template-assignments/delete project template assignment","metadata":{"seo":{"title":"Deleting an existing Project Template Assignment","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Project Template Assignment","name":"Deleting an existing Project Template Assignment","isWebhook":false,"pointer":"/paths/~1project_template_assignments~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Project Template Assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1project_template_assignments~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/project_template_assignments/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/project_template_assignments/{id}","href":"project-template-assignments/delete project template assignment","openApiOperationId":"Delete Project Template Assignment","summary":"Deleting an existing Project Template Assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Project Template Assignment has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_assignments~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_assignments/{id}"}],"content":{"contentType":"group","meta":{"name":"Project Template Assignments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project Template Assignments","showPageActions":true},{"nodeType":"markdoc","content":"Project Template Assignments(Project Template Resources) represent placeholders for task assignees\nin project templates. These assignments are mapped to project template stories and are assigned to\nreal users when the template is applied."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/project_template_assignments","summary":"Fetching a list of Project Template Assignments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-template-assignments/get project template assignments","deprecated":false},{"title":"/project_template_assignments","summary":"Creating a new Project Template Assignment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-template-assignments/create project template assignment","deprecated":false},{"title":"/project_template_assignments/{id}","summary":"Fetching a single Project Template Assignment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-template-assignments/get project template assignment","deprecated":false},{"title":"/project_template_assignments/{id}","summary":"Updating an existing Project Template Assignment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/project-template-assignments/update project template assignment","deprecated":false},{"title":"/project_template_assignments/{id}","summary":"Deleting an existing Project Template Assignment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/project-template-assignments/delete project template assignment","deprecated":false}]}]}]}]}},{"type":"group","label":"Project Template Expense Budgets","link":"/kantata/specification/project-template-expense-budgets","routeSlug":"/kantata/specification/project-template-expense-budgets","items":[{"label":"Fetching a list of Project Template Expense Budgets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-expense-budgets/get project template expense budgets","routeSlug":"/kantata/specification/project-template-expense-budgets/get project template expense budgets","metadata":{"seo":{"title":"Fetching a list of Project Template Expense Budgets","description":"This endpoint returns structured Project Template Expense Budget objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the project_template_expense_budgets top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Project Template Expense Budgets","name":"Fetching a list of Project Template Expense Budgets","isWebhook":false,"pointer":"/paths/~1project_template_expense_budgets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Project Template Expense Budgets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template Expense Budget objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_template_expense_budgets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_template` (ProjectTemplate) - Retrieves the template the expense budget is on. The response will include `project_template_id`,\nwhich references the data in the `project_templates` top-level key."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `title:asc`, and `title:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"project_template_id","in":"query","schemaId":"schema_313","description":"Filter by project template ID."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1project_template_expense_budgets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project_template_expense_budgets","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"project_template_id","in":"query","schemaId":"schema_313"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_template_expense_budgets","href":"project-template-expense-budgets/get project template expense budgets","openApiOperationId":"Get Project Template Expense Budgets","summary":"Fetching a list of Project Template Expense Budgets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Project Template Expense Budgets have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}},"schemaId":"schema_470"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_expense_budgets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_470","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_expense_budgets"},{"label":"Creating a new Project Template Expense Budget","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-expense-budgets/create project template expense budget","routeSlug":"/kantata/specification/project-template-expense-budgets/create project template expense budget","metadata":{"seo":{"title":"Creating a new Project Template Expense Budget","description":"Adds an expense budget to a project template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Project Template Expense Budget","name":"Creating a new Project Template Expense Budget","isWebhook":false,"pointer":"/paths/~1project_template_expense_budgets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Project Template Expense Budget","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds an expense budget to a project template."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"project_template_expense_budgets\": [\n {\n \"project_template_id\": 123,\n \"title\": \"Expense\",\n \"billable\": true,\n \"burns_budget\": true,\n \"fixed_fee\": false,\n \"cost_per_unit_in_subunits\": 10000,\n \"markup_type\": \"percentage\",\n \"markup_percentage\": 10,\n \"quantity\": 1\n },\n {\n \"project_template_id\": 123,\n \"title\": \"Expense 2\",\n \"billable\": true,\n \"burns_budget\": true,\n \"fixed_fee\": false,\n \"cost_per_unit_in_subunits\": 20000,\n \"markup_type\": \"percentage\",\n \"markup_percentage\": 10,\n \"quantity\": 1\n }\n ]\n} \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"project_template_expense_budgets\": [\n {\n \"project_template_id\": 123,\n \"title\": \"Expense\",\n \"billable\": true,\n \"burns_budget\": true,\n \"fixed_fee\": false,\n \"cost_per_unit_in_subunits\": 10000,\n \"markup_type\": \"percentage\",\n \"markup_percentage\": 10,\n \"quantity\": 1\n },\n {\n \"project_template_id\": 123,\n \"title\": \"Expense 2\",\n \"billable\": true,\n \"burns_budget\": true,\n \"fixed_fee\": false,\n \"cost_per_unit_in_subunits\": 20000,\n \"markup_type\": \"percentage\",\n \"markup_percentage\": 10,\n \"quantity\": 1\n }\n ]\n} \n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template Expense Budget objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_template_expense_budgets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_template` (ProjectTemplate) - Retrieves the template the expense budget is on. The response will include `project_template_id`,\nwhich references the data in the `project_templates` top-level key."}],"pointer":"/paths/~1project_template_expense_budgets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_471"}},"schemaId":"schema_471","pointer":"/paths/~1project_template_expense_budgets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/project_template_expense_budgets","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_471"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_template_expense_budgets","href":"project-template-expense-budgets/create project template expense budget","openApiOperationId":"Create Project Template Expense Budget","summary":"Creating a new Project Template Expense Budget"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_471","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_471"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project Template Expense Budget has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}},"schemaId":"schema_470"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_expense_budgets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_470","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_expense_budgets"},{"label":"Fetching a single Project Template Expense Budget","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-expense-budgets/get project template expense budget","routeSlug":"/kantata/specification/project-template-expense-budgets/get project template expense budget","metadata":{"seo":{"title":"Fetching a single Project Template Expense Budget","description":"This endpoint returns structured Project Template Expense Budget objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the project_template_expense_budgets top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Project Template Expense Budget","name":"Fetching a single Project Template Expense Budget","isWebhook":false,"pointer":"/paths/~1project_template_expense_budgets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Project Template Expense Budget","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template Expense Budget objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_template_expense_budgets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1project_template_expense_budgets~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_template` (ProjectTemplate) - Retrieves the template the expense budget is on. The response will include `project_template_id`,\nwhich references the data in the `project_templates` top-level key."}],"pointer":"/paths/~1project_template_expense_budgets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project_template_expense_budgets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_template_expense_budgets/{id}","href":"project-template-expense-budgets/get project template expense budget","openApiOperationId":"Get Project Template Expense Budget","summary":"Fetching a single Project Template Expense Budget"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Project Template Expense Budget has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}},"schemaId":"schema_470"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_expense_budgets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_470","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_expense_budgets/{id}"},{"label":"Updating an existing Project Template Expense Budget","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-expense-budgets/update project template expense budget","routeSlug":"/kantata/specification/project-template-expense-budgets/update project template expense budget","metadata":{"seo":{"title":"Updating an existing Project Template Expense Budget","description":"This endpoint returns structured Project Template Expense Budget objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the project_template_expense_budgets top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Project Template Expense Budget","name":"Updating an existing Project Template Expense Budget","isWebhook":false,"pointer":"/paths/~1project_template_expense_budgets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Project Template Expense Budget","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template Expense Budget objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_template_expense_budgets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1project_template_expense_budgets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_template` (ProjectTemplate) - Retrieves the template the expense budget is on. The response will include `project_template_id`,\nwhich references the data in the `project_templates` top-level key."}],"pointer":"/paths/~1project_template_expense_budgets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_472"}},"schemaId":"schema_472","pointer":"/paths/~1project_template_expense_budgets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/project_template_expense_budgets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_472"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_template_expense_budgets/{id}","href":"project-template-expense-budgets/update project template expense budget","openApiOperationId":"Update Project Template Expense Budget","summary":"Updating an existing Project Template Expense Budget"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_472","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_472"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project Template Expense Budget has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}},"schemaId":"schema_470"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_expense_budgets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_470","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_expense_budgets/{id}"},{"label":"Deleting an existing Project Template Expense Budget","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-template-expense-budgets/delete project template expense budget","routeSlug":"/kantata/specification/project-template-expense-budgets/delete project template expense budget","metadata":{"seo":{"title":"Deleting an existing Project Template Expense Budget","description":"Removes an expense budget from a project template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Project Template Expense Budget","name":"Deleting an existing Project Template Expense Budget","isWebhook":false,"pointer":"/paths/~1project_template_expense_budgets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Project Template Expense Budget","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes an expense budget from a project template."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1project_template_expense_budgets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/project_template_expense_budgets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/project_template_expense_budgets/{id}","href":"project-template-expense-budgets/delete project template expense budget","openApiOperationId":"Delete Project Template Expense Budget","summary":"Deleting an existing Project Template Expense Budget"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Project Template Expense Budget has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_template_expense_budgets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_template_expense_budgets/{id}"}],"content":{"contentType":"group","meta":{"name":"Project Template Expense Budgets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project Template Expense Budgets","showPageActions":true},{"nodeType":"markdoc","content":"Project Template Expense Budgets are expense budgets configured in a\nproject template that are added to a project when the template is applied."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/project_template_expense_budgets","summary":"Fetching a list of Project Template Expense Budgets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-template-expense-budgets/get project template expense budgets","deprecated":false},{"title":"/project_template_expense_budgets","summary":"Creating a new Project Template Expense Budget","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-template-expense-budgets/create project template expense budget","deprecated":false},{"title":"/project_template_expense_budgets/{id}","summary":"Fetching a single Project Template Expense Budget","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-template-expense-budgets/get project template expense budget","deprecated":false},{"title":"/project_template_expense_budgets/{id}","summary":"Updating an existing Project Template Expense Budget","prefix":{"name":"put","color":"put"},"badges":[],"link":"/project-template-expense-budgets/update project template expense budget","deprecated":false},{"title":"/project_template_expense_budgets/{id}","summary":"Deleting an existing Project Template Expense Budget","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/project-template-expense-budgets/delete project template expense budget","deprecated":false}]}]}]}]}},{"type":"group","label":"Project Templates","link":"/kantata/specification/project-templates","routeSlug":"/kantata/specification/project-templates","items":[{"type":"link","label":"Project Template Stories (Tasks) - raw_json","link":"/kantata/specification/project-templates/project-template-stories-(tasks)-raw_json","routeSlug":"/kantata/specification/project-templates/project-template-stories-(tasks)-raw_json","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Project Template Stories (Tasks) - raw_json"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":5,"id":"project-templates/project-template-stories-(tasks)-raw_json"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project Template Stories (Tasks) - raw_json"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A project template's tasks are all stored in an attribute located on the project template object called raw_json."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is a JSON hash of all the stories that has been turned into a string and is stored on the object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stories within the JSON have the following attributes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The title of the task."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The title of the project template."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relative_start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - An integer that represents the start day of the task relative to the start of the project."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relative_due_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - An integer that represents the end day of the task relative to the start of the project."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The number of days the task will take to complete."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"temp_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The unique reference ID for the task (used for dependencies)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The task description."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_estimate_in_cents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - An integer (whole number) that represents the budget estimate, in cents, for the task."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_estimate_in_minutes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - An integer (whole number) that represents the time estimate, in minutes, for the task."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_stories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - An nested array of sub-tasks that have the same structure as tasks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checklist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - An array of strings, each being a checklist item on the task."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"checklist\":[\"item one\", \"item two\"]."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A string with tags that are comma separated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, \"design, engineering, this has spaces.\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This creates three tags: \"design\", \"engineering\", and \"this has spaces.\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - An array of objects with key value pairs \"assignee_id\":id."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, [{\"assignee_id\":100},{\"assignee_id\":101}]"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This task would have two resources assigned to it. These are the IDs of two associated project template assignments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project template assignments are associated objects."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dependencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - An array of objects that represent a task's dependencies."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A dependency is an object that connects two tasks, and is used in Gantt charts. A dependency object lives"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the dependencies array on it's source task, not it's target."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dependencies have the following attributes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The temporary ID of the first task (source task) in the dependency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The temporary ID of the second task (target task) in the dependency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - There are four types of dependencies, numbered zero through three."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 - From the beginning of the source task to the beginning of the target task."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 - From the beginning of the source task to the end of the target task."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 - From the end of the source task to beginning of the target task."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 - From the end of the source task to end of the target task."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - An integer that represents the number of days delay that occurs between the two tasks in the dependency."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"raw_json example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"[\n {\n \"story_type\":\"task\",\n \"billable\":true,\n \"relative_start_date\":1,\n \"relative_due_date\":2,\n \"title\":\"Task One\",\n \"temp_id\":1,\n \"dependencies\":[{\"source_id\":1, \"target_id\":2, \"type\":2, \"lag\":0}],\n \"description\":\"this is a task\",\n \"assignments\":[{\"assignee_id\":\"26\"}],\n \"tag_list\":\"difficult,easy\",\n \"budget_estimate_in_cents\":40000,\n \"time_estimate_in_minutes\":1200,\n \"sub_stories\": [\n {\n \"story_type\":\"task\",\n \"billable\":true,\n \"due_date\":nil,\n \"start_date\":nil,\n \"relative_start_date\":1,\n \"relative_due_date\":3,\n \"title\":\"Sub Task One\",\n \"description\":\"this is a sub task\",\n \"assignments\":[{\"assignee_id\":\"27\"}],\n \"budget_estimate_in_cents\":20000,\n \"time_estimate_in_minutes\":300,\n \"temp_id\":3\n }\n ]\n },\n {\n \"story_type\":\"deliverable\",\n \"billable\":true,\n \"endDay\":4,\n \"relative_start_date\":1,\n \"relative_due_date\":4,\n \"title\":\"Deliverable One\",\n \"temp_id\":2,\n \"description\":\"this is a deliverable\",\n \"sub_stories\":[]\n },\n {\n \"story_type\":\"milestone\",\n \"billable\":true,\n \"title\":\"Milestone One\",\n \"description\":\"this is a milestone\",\n \"weight\":100,\n \"duration\":0,\n \"relative_start_date\":5,\n \"sub_stories\":[],\n \"checklist\":[\"item one\", \"item two\"],\n \"temp_id\":4\n }\n]\n```."},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"[\n {\n \"story_type\":\"task\",\n \"billable\":true,\n \"relative_start_date\":1,\n \"relative_due_date\":2,\n \"title\":\"Task One\",\n \"temp_id\":1,\n \"dependencies\":[{\"source_id\":1, \"target_id\":2, \"type\":2, \"lag\":0}],\n \"description\":\"this is a task\",\n \"assignments\":[{\"assignee_id\":\"26\"}],\n \"tag_list\":\"difficult,easy\",\n \"budget_estimate_in_cents\":40000,\n \"time_estimate_in_minutes\":1200,\n \"sub_stories\": [\n {\n \"story_type\":\"task\",\n \"billable\":true,\n \"due_date\":nil,\n \"start_date\":nil,\n \"relative_start_date\":1,\n \"relative_due_date\":3,\n \"title\":\"Sub Task One\",\n \"description\":\"this is a sub task\",\n \"assignments\":[{\"assignee_id\":\"27\"}],\n \"budget_estimate_in_cents\":20000,\n \"time_estimate_in_minutes\":300,\n \"temp_id\":3\n }\n ]\n },\n {\n \"story_type\":\"deliverable\",\n \"billable\":true,\n \"endDay\":4,\n \"relative_start_date\":1,\n \"relative_due_date\":4,\n \"title\":\"Deliverable One\",\n \"temp_id\":2,\n \"description\":\"this is a deliverable\",\n \"sub_stories\":[]\n },\n {\n \"story_type\":\"milestone\",\n \"billable\":true,\n \"title\":\"Milestone One\",\n \"description\":\"this is a milestone\",\n \"weight\":100,\n \"duration\":0,\n \"relative_start_date\":5,\n \"sub_stories\":[],\n \"checklist\":[\"item one\", \"item two\"],\n \"temp_id\":4\n }\n]\n```."},"children":[]}]}]}],"panels":[]}]}},{"label":"Fetching a list of Project Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-templates/get project templates","routeSlug":"/kantata/specification/project-templates/get project templates","metadata":{"seo":{"title":"Fetching a list of Project Templates","description":"This endpoint returns structured Project Template objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the project_templates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Project Templates","name":"Fetching a list of Project Templates","isWebhook":false,"pointer":"/paths/~1project_templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Project Templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_templates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"by_title","in":"query","schemaId":"schema_304","description":"Only includes project templates where the title matches the specified search."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_template_additional_tabs` (ProjectTemplateAdditionalTab) - Retrieves the additional tabs added to the template. The response will include `project_template_additional_tab_ids`, which references the data in the `project_template_additional_tabs` top-level key.\n- `project_template_assignments` (ProjectTemplateAssignment) - Project template assignments associated with the project template.\n- `user` (User) - The user who created the project template (referenced by user_id)."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Alias of by_title."},{"name":"mine","in":"query","schemaId":"schema_305","description":"Only includes project templates created by the requesting user."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"optional_fields","in":"query","schemaId":"schema_473","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `budget:asc`, `budget:desc`, `description:asc`, `description:desc`, `duration:asc`, `duration:desc`, `full_name:asc`, `full_name:desc`, `is_budgeted:asc`, `is_budgeted:desc`, `title:asc`, `title:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1project_templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project_templates","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"by_title","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"mine","in":"query","schemaId":"schema_305"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_473","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_templates","href":"project-templates/get project templates","openApiOperationId":"Get Project Templates","summary":"Fetching a list of Project Templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Project Templates have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}},"schemaId":"schema_474"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_474","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_templates"},{"label":"Creating a new Project Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-templates/create project template","routeSlug":"/kantata/specification/project-templates/create project template","metadata":{"seo":{"title":"Creating a new Project Template","description":"This endpoint returns structured Project Template objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the project_templates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Project Template","name":"Creating a new Project Template","isWebhook":false,"pointer":"/paths/~1project_templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Project Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_templates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_template_additional_tabs` (ProjectTemplateAdditionalTab) - Retrieves the additional tabs added to the template. The response will include `project_template_additional_tab_ids`, which references the data in the `project_template_additional_tabs` top-level key.\n- `project_template_assignments` (ProjectTemplateAssignment) - Project template assignments associated with the project template.\n- `user` (User) - The user who created the project template (referenced by user_id)."},{"name":"optional_fields","in":"query","schemaId":"schema_473","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1project_templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_475"}},"schemaId":"schema_475","pointer":"/paths/~1project_templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/project_templates","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_473","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_475"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_templates","href":"project-templates/create project template","openApiOperationId":"Create Project Template","summary":"Creating a new Project Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_475","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_475"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project Template has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}},"schemaId":"schema_474"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_templates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_474","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_templates"},{"label":"Fetching a single Project Template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-templates/get project template","routeSlug":"/kantata/specification/project-templates/get project template","metadata":{"seo":{"title":"Fetching a single Project Template","description":"This endpoint returns structured Project Template objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the project_templates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Project Template","name":"Fetching a single Project Template","isWebhook":false,"pointer":"/paths/~1project_templates~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Project Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_templates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1project_templates~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_template_additional_tabs` (ProjectTemplateAdditionalTab) - Retrieves the additional tabs added to the template. The response will include `project_template_additional_tab_ids`, which references the data in the `project_template_additional_tabs` top-level key.\n- `project_template_assignments` (ProjectTemplateAssignment) - Project template assignments associated with the project template.\n- `user` (User) - The user who created the project template (referenced by user_id)."},{"name":"optional_fields","in":"query","schemaId":"schema_473","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1project_templates~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project_templates/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_473","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_templates/{id}","href":"project-templates/get project template","openApiOperationId":"Get Project Template","summary":"Fetching a single Project Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Project Template has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}},"schemaId":"schema_474"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_templates~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_474","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_templates/{id}"},{"label":"Updating an existing Project Template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-templates/update project template","routeSlug":"/kantata/specification/project-templates/update project template","metadata":{"seo":{"title":"Updating an existing Project Template","description":"This endpoint returns structured Project Template objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the project_templates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Project Template","name":"Updating an existing Project Template","isWebhook":false,"pointer":"/paths/~1project_templates~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Project Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Template objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_templates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1project_templates~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `project_template_additional_tabs` (ProjectTemplateAdditionalTab) - Retrieves the additional tabs added to the template. The response will include `project_template_additional_tab_ids`, which references the data in the `project_template_additional_tabs` top-level key.\n- `project_template_assignments` (ProjectTemplateAssignment) - Project template assignments associated with the project template.\n- `user` (User) - The user who created the project template (referenced by user_id)."},{"name":"optional_fields","in":"query","schemaId":"schema_473","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1project_templates~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_476"}},"schemaId":"schema_476","pointer":"/paths/~1project_templates~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/project_templates/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_473","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_476"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_templates/{id}","href":"project-templates/update project template","openApiOperationId":"Update Project Template","summary":"Updating an existing Project Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_476","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_476"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project Template has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}},"schemaId":"schema_474"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_templates~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_474","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_templates/{id}"},{"label":"Deleting an existing Project Template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-templates/delete project template","routeSlug":"/kantata/specification/project-templates/delete project template","metadata":{"seo":{"title":"Deleting an existing Project Template","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Project Template","name":"Deleting an existing Project Template","isWebhook":false,"pointer":"/paths/~1project_templates~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Project Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1project_templates~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/project_templates/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/project_templates/{id}","href":"project-templates/delete project template","openApiOperationId":"Delete Project Template","summary":"Deleting an existing Project Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Project Template has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_templates~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_templates/{id}"}],"content":{"contentType":"group","meta":{"name":"Project Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project Templates","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project Templates are sets of tasks and attributes that can be applied to new or existing projects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single template can be used on any number of projects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A project template's tasks are all stored in an attribute located on the project template object called raw_json."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is a JSON hash of all the stories that has been turned into a string and is stored on the object."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/project_templates","summary":"Fetching a list of Project Templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-templates/get project templates","deprecated":false},{"title":"/project_templates","summary":"Creating a new Project Template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-templates/create project template","deprecated":false},{"title":"/project_templates/{id}","summary":"Fetching a single Project Template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-templates/get project template","deprecated":false},{"title":"/project_templates/{id}","summary":"Updating an existing Project Template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/project-templates/update project template","deprecated":false},{"title":"/project_templates/{id}","summary":"Deleting an existing Project Template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/project-templates/delete project template","deprecated":false}]}]}]}]}},{"type":"separator","label":"Projects","content":null},{"type":"group","label":"Participations","link":"/kantata/specification/participations","routeSlug":"/kantata/specification/participations","items":[{"label":"Fetching a list of Participations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/participations/get participations","routeSlug":"/kantata/specification/participations/get participations","metadata":{"seo":{"title":"Fetching a list of Participations","description":"The Participations index action only returns participations from projects that are visible to the requester.See the Projects KB documentation for more information about how visibility restrictions work."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Participations","name":"Fetching a list of Participations","isWebhook":false,"pointer":"/paths/~1participations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Participations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Participations index action only returns participations from projects that are visible to the requester."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/sections/200022139-Projects"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Projects KB documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about how visibility restrictions work."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Participation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"participations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"This parameter is required to identify the project you want to retrieve participations for.","required":true},{"name":"by_user","in":"query","schemaId":"schema_313","description":"Retrieves participations for the specified user ID."},{"name":"by_user_full_name","in":"query","schemaId":"schema_304","description":"Matches against users' full names."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `active_roles` (Role) - Retrieves all of the project roles of the participant. The response will include `active_role_ids`, which references the data in the `roles` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `primary_role` (Role) - Retrieves account role of the participant. Only visible when the authenticated user is on the same account the project is on. The response will include `primary_role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Retrieves the user (also known as the participant). The response will include `user_id`, which references the data in the `users` top-level key.\n- `workspace` (Workspace) - Retrieves the project. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the resource(s) associated with the participation, ordered alphabetically. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_role` (Role) - Retrieves the primary project role for the participant. The response will include `workspace_role_id`, which references the data in the `roles` top-level key."},{"name":"mavens_only","in":"query","schemaId":"schema_305","description":"Only consultant participations."},{"name":"not_assigned_to_story","in":"query","schemaId":"schema_313","description":"Not assigned to the specified story ID."},{"name":"not_following_story","in":"query","schemaId":"schema_313","description":"Not following the specified story ID."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"optional_fields","in":"query","schemaId":"schema_477","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `updated_at:asc`, `updated_at:desc`, `user_name:asc`, and `user_name:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1participations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/participations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"workspace_id","in":"query","required":true,"schemaId":"schema_313"},{"name":"by_user","in":"query","schemaId":"schema_313"},{"name":"by_user_full_name","in":"query","schemaId":"schema_304"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"mavens_only","in":"query","schemaId":"schema_305"},{"name":"not_assigned_to_story","in":"query","schemaId":"schema_313"},{"name":"not_following_story","in":"query","schemaId":"schema_313"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_477","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/participations","href":"participations/get participations","openApiOperationId":"Get Participations","summary":"Fetching a list of Participations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Participations have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}},"schemaId":"schema_478"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1participations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_478","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/participations"},{"label":"Creating a new Participation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/participations/create participation","routeSlug":"/kantata/specification/participations/create participation","metadata":{"seo":{"title":"Creating a new Participation","description":"Adds a user to a project (workspace)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Participation","name":"Creating a new Participation","isWebhook":false,"pointer":"/paths/~1participations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Participation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a user to a project (workspace)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"participations\": [\n {\n \"workspace_id\": 123,\n \"role\": \"maven\",\n \"user_id\": 111\n },\n {\n \"workspace_id\": 123,\n \"role\": \"maven\",\n \"user_id\": 222\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"participations\": [\n {\n \"workspace_id\": 123,\n \"role\": \"maven\",\n \"user_id\": 111\n },\n {\n \"workspace_id\": 123,\n \"role\": \"maven\",\n \"user_id\": 222\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Participation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"participations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `active_roles` (Role) - Retrieves all of the project roles of the participant. The response will include `active_role_ids`, which references the data in the `roles` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `primary_role` (Role) - Retrieves account role of the participant. Only visible when the authenticated user is on the same account the project is on. The response will include `primary_role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Retrieves the user (also known as the participant). The response will include `user_id`, which references the data in the `users` top-level key.\n- `workspace` (Workspace) - Retrieves the project. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the resource(s) associated with the participation, ordered alphabetically. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_role` (Role) - Retrieves the primary project role for the participant. The response will include `workspace_role_id`, which references the data in the `roles` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_477","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1participations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_479"}},"schemaId":"schema_479","pointer":"/paths/~1participations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/participations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_477","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_479"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/participations","href":"participations/create participation","openApiOperationId":"Create Participation","summary":"Creating a new Participation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_479","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_479"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Participation has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}},"schemaId":"schema_478"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1participations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_478","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/participations"},{"label":"Fetching a single Participation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/participations/get participation","routeSlug":"/kantata/specification/participations/get participation","metadata":{"seo":{"title":"Fetching a single Participation","description":"This endpoint returns structured Participation objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the participations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Participation","name":"Fetching a single Participation","isWebhook":false,"pointer":"/paths/~1participations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Participation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Participation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"participations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1participations~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `active_roles` (Role) - Retrieves all of the project roles of the participant. The response will include `active_role_ids`, which references the data in the `roles` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `primary_role` (Role) - Retrieves account role of the participant. Only visible when the authenticated user is on the same account the project is on. The response will include `primary_role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Retrieves the user (also known as the participant). The response will include `user_id`, which references the data in the `users` top-level key.\n- `workspace` (Workspace) - Retrieves the project. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the resource(s) associated with the participation, ordered alphabetically. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_role` (Role) - Retrieves the primary project role for the participant. The response will include `workspace_role_id`, which references the data in the `roles` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_477","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1participations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/participations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_477","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/participations/{id}","href":"participations/get participation","openApiOperationId":"Get Participation","summary":"Fetching a single Participation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Participation has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}},"schemaId":"schema_478"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1participations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_478","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/participations/{id}"},{"label":"Updating an existing Participation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/participations/update participation","routeSlug":"/kantata/specification/participations/update participation","metadata":{"seo":{"title":"Updating an existing Participation","description":"This endpoint returns structured Participation objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the participations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Participation","name":"Updating an existing Participation","isWebhook":false,"pointer":"/paths/~1participations~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Participation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Participation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"participations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1participations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `active_roles` (Role) - Retrieves all of the project roles of the participant. The response will include `active_role_ids`, which references the data in the `roles` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `primary_role` (Role) - Retrieves account role of the participant. Only visible when the authenticated user is on the same account the project is on. The response will include `primary_role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Retrieves the user (also known as the participant). The response will include `user_id`, which references the data in the `users` top-level key.\n- `workspace` (Workspace) - Retrieves the project. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the resource(s) associated with the participation, ordered alphabetically. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_role` (Role) - Retrieves the primary project role for the participant. The response will include `workspace_role_id`, which references the data in the `roles` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_477","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1participations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_480"}},"schemaId":"schema_480","pointer":"/paths/~1participations~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/participations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_477","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_480"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/participations/{id}","href":"participations/update participation","openApiOperationId":"Update Participation","summary":"Updating an existing Participation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_480","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_480"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Participation has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}},"schemaId":"schema_478"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1participations~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_478","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/participations/{id}"},{"label":"Deleting an existing Participation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/participations/delete participation","routeSlug":"/kantata/specification/participations/delete participation","metadata":{"seo":{"title":"Deleting an existing Participation","description":"Removes a participant from a project and deletes their associated project data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Participation","name":"Deleting an existing Participation","isWebhook":false,"pointer":"/paths/~1participations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Participation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes a participant from a project and deletes their associated project data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1participations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/participations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/participations/{id}","href":"participations/delete participation","openApiOperationId":"Delete Participation","summary":"Deleting an existing Participation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Participation has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1participations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/participations/{id}"}],"content":{"contentType":"group","meta":{"name":"Participations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Participations","showPageActions":true},{"nodeType":"markdoc","content":"A participation represents the relationship between a participant and a project, including a participant's permission level,\nwhether they're a provider or client, and many other properties. See the 200 status code\nresponse sample for an example of participation properties you can access."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/participations","summary":"Fetching a list of Participations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/participations/get participations","deprecated":false},{"title":"/participations","summary":"Creating a new Participation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/participations/create participation","deprecated":false},{"title":"/participations/{id}","summary":"Fetching a single Participation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/participations/get participation","deprecated":false},{"title":"/participations/{id}","summary":"Updating an existing Participation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/participations/update participation","deprecated":false},{"title":"/participations/{id}","summary":"Deleting an existing Participation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/participations/delete participation","deprecated":false}]}]}]}]}},{"type":"group","label":"Project Accounting Records","link":"/kantata/specification/project-accounting-records","routeSlug":"/kantata/specification/project-accounting-records","items":[{"label":"Fetching a list of Project Accounting Records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-accounting-records/get project accounting records","routeSlug":"/kantata/specification/project-accounting-records/get project accounting records","metadata":{"seo":{"title":"Fetching a list of Project Accounting Records","description":"Returns all project accounting records (Baseline, Earned Value, Earned Value Forecasting,Forecasting, and Recognition), unless filter parameters have been applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Project Accounting Records","name":"Fetching a list of Project Accounting Records","isWebhook":false,"pointer":"/paths/~1project_accounting_records/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Project Accounting Records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all project accounting records ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Baseline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Earned Value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Earned Value Forecasting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Forecasting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), unless filter parameters have been applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Accounting Records objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_accounting_records"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_at","in":"query","schemaId":"schema_303","description":"Filters for records created on or after the specified date (e.g. `GET /api/v1/project_accounting_records.json?created_at=2014-02-25`). The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"end_date","in":"query","schemaId":"schema_368","description":"Filters for records with accounting periods that end on specified dates.\n\nYou can filter for records with an accounting period that ends...\n* within a date range, with a pair of semicolon-separated dates (e.g. `2019-09-14;2019-09-15`),\n* on or _after_ a date, with only the date before the semicolon (e.g. `2019-09-14;`),\n* on or _before_ a date, with only the date after the semicolon (e.g. `;2019-09-14`). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"ids","in":"query","schemaId":"schema_352","description":"Filters for records with the specified IDs. Give multiple record IDs\n in a comma-separated list (e.g. `GET /api/v1/project_accounting_records.json?ids=55,16,73`)."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `role` (Role) - Includes the ID of the role associated with the record.\n- `story` (Story) - Includes the ID of the task related to the record.\n- `user` (User) - Includes the ID(s) of user(s) associated with the record\n (e.g. who created the record, who the record was created for, etc.).\n- `workspace` (Workspace) - Includes the ID of the project the record belongs to."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"show_deleted","in":"query","schemaId":"schema_305","description":"If `true`, returns only deleted project accounting records. Set to `false` by default."},{"name":"start_date","in":"query","schemaId":"schema_368","description":"Filters for records with accounting periods that begin on specified dates.\n\nYou can filter for records with an accounting period that begins...\n* within a date range, with a pair of semicolon-separated dates (e.g. `2019-09-14;2019-09-15`),\n* on or _after_ a date, with only the date before the semicolon (e.g. `2019-09-14;`),\n* on or _before_ a date, with only the date after the semicolon (e.g. `;2019-09-14`). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"status","in":"query","schemaId":"schema_481","description":"Filters for records with the specified status.\n\nValid values: `Draft`, `Pending Approval`, `Approved`, `Cancelled`.\n\n*Note:* Records without a status cannot be returned with this filter."},{"name":"type","in":"query","schemaId":"schema_304","description":"Only includes Project Accounting Records of the specified type.\n Valid values: `Baseline`, `Earned Value`, `Earned Value Forecasting`, `Forecasting`, `Recognition`."},{"name":"user_id","in":"query","schemaId":"schema_313","description":"Only includes Project Accounting Records for the specified user_id."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_ids","in":"query","schemaId":"schema_352","description":"Filters for records from projects with the specified IDs. Give multiple project IDs\n in a comma-separated list (e.g. `GET /api/v1/project_accounting_records.json?workspace_ids=25344,76545`)."}],"pointer":"/paths/~1project_accounting_records/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project_accounting_records","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_at","in":"query","required":false,"schemaId":"schema_303"},{"name":"end_date","in":"query","required":false,"schemaId":"schema_368"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"ids","in":"query","required":false,"schemaId":"schema_352","style":"form","explode":false},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"show_deleted","in":"query","required":false,"schemaId":"schema_305"},{"name":"start_date","in":"query","required":false,"schemaId":"schema_368"},{"name":"status","in":"query","required":false,"schemaId":"schema_481","style":"form","explode":false},{"name":"type","in":"query","schemaId":"schema_304"},{"name":"user_id","in":"query","schemaId":"schema_313"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_ids","in":"query","required":false,"schemaId":"schema_352","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_accounting_records","href":"project-accounting-records/get project accounting records","openApiOperationId":"Get Project Accounting Records","summary":"Fetching a list of Project Accounting Records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Project Accounting Records have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}},"schemaId":"schema_482"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_accounting_records/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_482","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_accounting_records"},{"label":"Creating a new Project Accounting Records","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-accounting-records/create project accounting record","routeSlug":"/kantata/specification/project-accounting-records/create project accounting record","metadata":{"seo":{"title":"Creating a new Project Accounting Records","description":"Creates a single or multiple project accounting records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Project Accounting Record","name":"Creating a new Project Accounting Records","isWebhook":false,"pointer":"/paths/~1project_accounting_records/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Project Accounting Records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a single or multiple project accounting records."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Accounting Records objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_accounting_records"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `role` (Role) - Includes the ID of the role associated with the record.\n- `story` (Story) - Includes the ID of the task related to the record.\n- `user` (User) - Includes the ID(s) of user(s) associated with the record\n (e.g. who created the record, who the record was created for, etc.).\n- `workspace` (Workspace) - Includes the ID of the project the record belongs to."}],"pointer":"/paths/~1project_accounting_records/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_483"}},"schemaId":"schema_483","pointer":"/paths/~1project_accounting_records/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/project_accounting_records","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_483"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_accounting_records","href":"project-accounting-records/create project accounting record","openApiOperationId":"Create Project Accounting Record","summary":"Creating a new Project Accounting Records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_483","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_483"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project Accounting Records has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}},"schemaId":"schema_482"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_accounting_records/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_482","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_accounting_records"},{"label":"Soft Deleting a Project Accounting Record","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-accounting-records/soft delete project accounting record","routeSlug":"/kantata/specification/project-accounting-records/soft delete project accounting record","metadata":{"seo":{"title":"Soft Deleting a Project Accounting Record","description":"Soft deletes a specified project accounting record. View deleted records byFetching a list of Project Accounting Records with the show_deleted filter set to true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Soft Delete Project Accounting Record","name":"Soft Deleting a Project Accounting Record","isWebhook":false,"pointer":"/paths/~1project_accounting_records~1delete/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Soft Deleting a Project Accounting Record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Soft deletes a specified project accounting record. View deleted records by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetching a list of Project Accounting Records with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"show_deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Accounting Records objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_accounting_records"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"csv_file","in":"query","schemaId":"schema_304","description":"The ID(s) of record(s) to delete, in a\n [.csv file](https://app.mavenlink.com/sample_remove_project_accounting_records.csv)\n with rows/lines of ID numbers under a header of `ID`."},{"name":"ids","in":"query","schemaId":"schema_481","description":"The ID(s) of record(s) to delete, in an array."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `role` (Role) - Includes the ID of the role associated with the record.\n- `story` (Story) - Includes the ID of the task related to the record.\n- `user` (User) - Includes the ID(s) of user(s) associated with the record\n (e.g. who created the record, who the record was created for, etc.).\n- `workspace` (Workspace) - Includes the ID of the project the record belongs to."}],"pointer":"/paths/~1project_accounting_records~1delete/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/project_accounting_records/delete","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"csv_file","in":"query","required":false,"schemaId":"schema_304","style":"form","explode":false},{"name":"ids","in":"query","required":false,"schemaId":"schema_481","style":"form","explode":false},{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_accounting_records/delete","href":"project-accounting-records/soft delete project accounting record","openApiOperationId":"Soft Delete Project Accounting Record","summary":"Soft Deleting a Project Accounting Record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project Accounting Records has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}},"schemaId":"schema_482"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_accounting_records~1delete/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_482","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_accounting_records/delete"},{"label":"Exporting Project Account Records in a CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-accounting-records/export project accounting record to csv","routeSlug":"/kantata/specification/project-accounting-records/export project accounting record to csv","metadata":{"seo":{"title":"Exporting Project Account Records in a CSV","description":"Downloads a .csv file of all project accounting records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Export Project Accounting Record To Csv","name":"Exporting Project Account Records in a CSV","isWebhook":false,"pointer":"/paths/~1project_accounting_records~1export_to_csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exporting Project Account Records in a CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Downloads a .csv file of all project accounting records."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Accounting Records objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_accounting_records"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `role` (Role) - Includes the ID of the role associated with the record.\n- `story` (Story) - Includes the ID of the task related to the record.\n- `user` (User) - Includes the ID(s) of user(s) associated with the record\n (e.g. who created the record, who the record was created for, etc.).\n- `workspace` (Workspace) - Includes the ID of the project the record belongs to."}],"pointer":"/paths/~1project_accounting_records~1export_to_csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project_accounting_records/export_to_csv","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_accounting_records/export_to_csv","href":"project-accounting-records/export project accounting record to csv","openApiOperationId":"Export Project Accounting Record To Csv","summary":"Exporting Project Account Records in a CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Project Accounting Records have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}},"schemaId":"schema_482"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_accounting_records~1export_to_csv/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_482","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_accounting_records/export_to_csv"},{"label":"Importing Project Account Records in a CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-accounting-records/import project accounting records","routeSlug":"/kantata/specification/project-accounting-records/import project accounting records","metadata":{"seo":{"title":"Importing Project Account Records in a CSV","description":"Imports up to 5000 project accounting records with acsv filewith a .txt or .csv extension."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Import Project Accounting Records","name":"Importing Project Account Records in a CSV","isWebhook":false,"pointer":"/paths/~1project_accounting_records~1import_csv/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Importing Project Account Records in a CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Imports up to 5000 project accounting records with a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.mavenlink.com/sample_import_project_accounting_records.csv"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"csv file"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a .txt or .csv extension."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each row/line is a record, and each record has attributes. Headers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indicate which attributes are being specified for imported records."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Headers can include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Story ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (recommended)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period Start Date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period End Date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contract Date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Method"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount To Date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forecast"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Budget"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost to Date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost EAC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Labor Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hours"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hours EAC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hours ETC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total Estimated Hours"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total Hours to Date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent Complete"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period Start Date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period End Date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required for a csv import. But when it is not specified,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Other valid values for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Baseline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Earned Value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Earned Value Forecasting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Forecasting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Accounting Records objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_accounting_records"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `role` (Role) - Includes the ID of the role associated with the record.\n- `story` (Story) - Includes the ID of the task related to the record.\n- `user` (User) - Includes the ID(s) of user(s) associated with the record\n (e.g. who created the record, who the record was created for, etc.).\n- `workspace` (Workspace) - Includes the ID of the project the record belongs to."}],"pointer":"/paths/~1project_accounting_records~1import_csv/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/project_accounting_records/import_csv","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_accounting_records/import_csv","href":"project-accounting-records/import project accounting records","openApiOperationId":"Import Project Accounting Records","summary":"Importing Project Account Records in a CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project Accounting Records has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}},"schemaId":"schema_482"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_accounting_records~1import_csv/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_482","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_accounting_records/import_csv"},{"label":"Fetching a single Project Accounting Records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/project-accounting-records/get project accounting record","routeSlug":"/kantata/specification/project-accounting-records/get project accounting record","metadata":{"seo":{"title":"Fetching a single Project Accounting Records","description":"Returns a specified project accounting record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Project Accounting Record","name":"Fetching a single Project Accounting Records","isWebhook":false,"pointer":"/paths/~1project_accounting_records~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Project Accounting Records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a specified project accounting record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Project Accounting Records objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_accounting_records"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1project_accounting_records~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `role` (Role) - Includes the ID of the role associated with the record.\n- `story` (Story) - Includes the ID of the task related to the record.\n- `user` (User) - Includes the ID(s) of user(s) associated with the record\n (e.g. who created the record, who the record was created for, etc.).\n- `workspace` (Workspace) - Includes the ID of the project the record belongs to."}],"pointer":"/paths/~1project_accounting_records~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/project_accounting_records/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/project_accounting_records/{id}","href":"project-accounting-records/get project accounting record","openApiOperationId":"Get Project Accounting Record","summary":"Fetching a single Project Accounting Records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Project Accounting Records has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}},"schemaId":"schema_482"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1project_accounting_records~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_482","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/project_accounting_records/{id}"}],"content":{"contentType":"group","meta":{"name":"Project Accounting Records"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project Accounting Records","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/4403832107419-Project-Accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Records object allows you to view, create, and delete financial records"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"related to revenue recognition, forecasting, and earned value."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/project_accounting_records","summary":"Fetching a list of Project Accounting Records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-accounting-records/get project accounting records","deprecated":false},{"title":"/project_accounting_records","summary":"Creating a new Project Accounting Records","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-accounting-records/create project accounting record","deprecated":false},{"title":"/project_accounting_records/delete","summary":"Soft Deleting a Project Accounting Record","prefix":{"name":"put","color":"put"},"badges":[],"link":"/project-accounting-records/soft delete project accounting record","deprecated":false},{"title":"/project_accounting_records/export_to_csv","summary":"Exporting Project Account Records in a CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-accounting-records/export project accounting record to csv","deprecated":false},{"title":"/project_accounting_records/import_csv","summary":"Importing Project Account Records in a CSV","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-accounting-records/import project accounting records","deprecated":false},{"title":"/project_accounting_records/{id}","summary":"Fetching a single Project Accounting Records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-accounting-records/get project accounting record","deprecated":false}]}]}]}]}},{"type":"group","label":"Status Reports","link":"/kantata/specification/status-reports","routeSlug":"/kantata/specification/status-reports","items":[{"label":"Fetching a list of Status Reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/status-reports/get status reports","routeSlug":"/kantata/specification/status-reports/get status reports","metadata":{"seo":{"title":"Fetching a list of Status Reports","description":"This endpoint returns structured Status Report objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the status_reports top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Status Reports","name":"Fetching a list of Status Reports","isWebhook":false,"pointer":"/paths/~1status_reports/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Status Reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Status Report objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status_reports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user who created the status report.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `updater` (User) - The user who last updated the status report.\n- `workspace` (Workspace) - The workspace associated with the status report."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Return only status reports for the given workspace_id."}],"pointer":"/paths/~1status_reports/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/status_reports","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","required":false,"schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/status_reports","href":"status-reports/get status reports","openApiOperationId":"Get Status Reports","summary":"Fetching a list of Status Reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Status Reports have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_484"}},"schemaId":"schema_484"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1status_reports/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_484","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_484"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/status_reports"},{"label":"Creating a new Status Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/status-reports/create status report","routeSlug":"/kantata/specification/status-reports/create status report","metadata":{"seo":{"title":"Creating a new Status Report","description":"This endpoint returns structured Status Report objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the status_reports top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Status Report","name":"Creating a new Status Report","isWebhook":false,"pointer":"/paths/~1status_reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Status Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Status Report objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status_reports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user who created the status report.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `updater` (User) - The user who last updated the status report.\n- `workspace` (Workspace) - The workspace associated with the status report."}],"pointer":"/paths/~1status_reports/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_485"}},"schemaId":"schema_485","pointer":"/paths/~1status_reports/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/status_reports","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_485"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/status_reports","href":"status-reports/create status report","openApiOperationId":"Create Status Report","summary":"Creating a new Status Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_485","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_485"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Status Report has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_484"}},"schemaId":"schema_484"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1status_reports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_484","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_484"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/status_reports"},{"label":"Fetching a single Status Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/status-reports/get status report","routeSlug":"/kantata/specification/status-reports/get status report","metadata":{"seo":{"title":"Fetching a single Status Report","description":"This endpoint returns structured Status Report objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the status_reports top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Status Report","name":"Fetching a single Status Report","isWebhook":false,"pointer":"/paths/~1status_reports~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Status Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Status Report objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status_reports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1status_reports~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user who created the status report.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `updater` (User) - The user who last updated the status report.\n- `workspace` (Workspace) - The workspace associated with the status report."}],"pointer":"/paths/~1status_reports~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/status_reports/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/status_reports/{id}","href":"status-reports/get status report","openApiOperationId":"Get Status Report","summary":"Fetching a single Status Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Status Report has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_484"}},"schemaId":"schema_484"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1status_reports~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_484","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_484"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/status_reports/{id}"},{"label":"Updating an existing Status Report","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/status-reports/update status report","routeSlug":"/kantata/specification/status-reports/update status report","metadata":{"seo":{"title":"Updating an existing Status Report","description":"This endpoint returns structured Status Report objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the status_reports top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Status Report","name":"Updating an existing Status Report","isWebhook":false,"pointer":"/paths/~1status_reports~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Status Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Status Report objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status_reports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1status_reports~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user who created the status report.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `updater` (User) - The user who last updated the status report.\n- `workspace` (Workspace) - The workspace associated with the status report."}],"pointer":"/paths/~1status_reports~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_486"}},"schemaId":"schema_486","pointer":"/paths/~1status_reports~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/status_reports/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_486"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/status_reports/{id}","href":"status-reports/update status report","openApiOperationId":"Update Status Report","summary":"Updating an existing Status Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_486","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_486"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Status Report has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_484"}},"schemaId":"schema_484"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1status_reports~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_484","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_484"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/status_reports/{id}"},{"label":"Deleting an existing Status Report","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/status-reports/delete status report","routeSlug":"/kantata/specification/status-reports/delete status report","metadata":{"seo":{"title":"Deleting an existing Status Report","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Status Report","name":"Deleting an existing Status Report","isWebhook":false,"pointer":"/paths/~1status_reports~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Status Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1status_reports~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/status_reports/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/status_reports/{id}","href":"status-reports/delete status report","openApiOperationId":"Delete Status Report","summary":"Deleting an existing Status Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Status Report has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1status_reports~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/status_reports/{id}"}],"content":{"contentType":"group","meta":{"name":"Status Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Status Reports","showPageActions":true},{"nodeType":"markdoc","content":"A Status Report represents a snapshot of a Workspace's status across several categories at a moment\nin time. Status Reports are usually referred to as Health Reports in the UI."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/status_reports","summary":"Fetching a list of Status Reports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status-reports/get status reports","deprecated":false},{"title":"/status_reports","summary":"Creating a new Status Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/status-reports/create status report","deprecated":false},{"title":"/status_reports/{id}","summary":"Fetching a single Status Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status-reports/get status report","deprecated":false},{"title":"/status_reports/{id}","summary":"Updating an existing Status Report","prefix":{"name":"put","color":"put"},"badges":[],"link":"/status-reports/update status report","deprecated":false},{"title":"/status_reports/{id}","summary":"Deleting an existing Status Report","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/status-reports/delete status report","deprecated":false}]}]}]}]}},{"type":"group","label":"Workspace Allocations","link":"/kantata/specification/workspace-allocations","routeSlug":"/kantata/specification/workspace-allocations","items":[{"label":"Fetching a list of Workspace Allocations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-allocations/get workspace allocations","routeSlug":"/kantata/specification/workspace-allocations/get workspace allocations","metadata":{"seo":{"title":"Fetching a list of Workspace Allocations","description":"This endpoint returns structured Workspace Allocation objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_allocations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Allocations","name":"Fetching a list of Workspace Allocations","isWebhook":false,"pointer":"/paths/~1workspace_allocations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Workspace Allocations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Allocation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_allocations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User)\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `updater` (User)\n- `workspace` (Workspace) - The workspace that the resource is allocated in.\n- `workspace_resource` (WorkspaceResource)."},{"name":"named_resources_only","in":"query","schemaId":"schema_305","description":"Limit to allocations associated with only named resources."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `updated_at:asc` and `updated_at:desc`."},{"name":"overlaps_with_date_range","in":"query","schemaId":"schema_304","description":"Limit to allocations of that overlap with a specified date range. Accepts two dates separated by a colon."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"type","in":"query","schemaId":"schema_304","description":"Limit to allocations of a specific type. Valid values: `hard` and `soft`."},{"name":"unnamed_resources_only","in":"query","schemaId":"schema_305","description":"Limit to allocations associated with only unnamed resources."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"user_ids","in":"query","schemaId":"schema_304","description":"Limit to allocations associated with the workspace resource user's IDs."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_ids","in":"query","schemaId":"schema_304","description":"Limit to allocations associated with the workspace IDs."},{"name":"workspace_resource_ids","in":"query","schemaId":"schema_304","description":"Limit to allocations associated with the workspace resource IDs."}],"pointer":"/paths/~1workspace_allocations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_allocations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"named_resources_only","in":"query","schemaId":"schema_305"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"overlaps_with_date_range","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"type","in":"query","schemaId":"schema_304"},{"name":"unnamed_resources_only","in":"query","schemaId":"schema_305"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"user_ids","in":"query","schemaId":"schema_304"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_ids","in":"query","schemaId":"schema_304"},{"name":"workspace_resource_ids","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_allocations","href":"workspace-allocations/get workspace allocations","openApiOperationId":"Get Workspace Allocations","summary":"Fetching a list of Workspace Allocations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Workspace Allocations have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_487"}},"schemaId":"schema_487"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_allocations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_487","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_487"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_allocations"},{"label":"Creating a new Workspace Allocation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-allocations/create workspace allocation","routeSlug":"/kantata/specification/workspace-allocations/create workspace allocation","metadata":{"seo":{"title":"Creating a new Workspace Allocation","description":"Creates a workspace allocation for a resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workspace Allocation","name":"Creating a new Workspace Allocation","isWebhook":false,"pointer":"/paths/~1workspace_allocations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Workspace Allocation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a workspace allocation for a resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 200 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"workspace_allocations\": [\n {\n \"resource_id\": 123,\n \"start_date\": \"2025-03-03\",\n \"end_date\": \"2025-03-07\",\n \"minutes\": 2100\n },\n {\n \"resource_id\": 123,\n \"start_date\": \"2025-04-07\",\n \"end_date\": \"2025-07-11\",\n \"minutes\": 2100\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"workspace_allocations\": [\n {\n \"resource_id\": 123,\n \"start_date\": \"2025-03-03\",\n \"end_date\": \"2025-03-07\",\n \"minutes\": 2100\n },\n {\n \"resource_id\": 123,\n \"start_date\": \"2025-04-07\",\n \"end_date\": \"2025-07-11\",\n \"minutes\": 2100\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Allocation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_allocations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User)\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `updater` (User)\n- `workspace` (Workspace) - The workspace that the resource is allocated in.\n- `workspace_resource` (WorkspaceResource)."}],"pointer":"/paths/~1workspace_allocations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_488"}},"schemaId":"schema_488","pointer":"/paths/~1workspace_allocations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workspace_allocations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_488"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_allocations","href":"workspace-allocations/create workspace allocation","openApiOperationId":"Create Workspace Allocation","summary":"Creating a new Workspace Allocation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_488","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_488"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Allocation has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_487"}},"schemaId":"schema_487"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_allocations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_487","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_487"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_allocations"},{"label":"Splitting an Allocation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-allocations/split workspace allocation by date","routeSlug":"/kantata/specification/workspace-allocations/split workspace allocation by date","metadata":{"seo":{"title":"Splitting an Allocation","description":"Split an existing allocation into two on the specified date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Split Workspace Allocation By Date","name":"Splitting an Allocation","isWebhook":false,"pointer":"/paths/~1workspace_allocations~1split/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Splitting an Allocation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split an existing allocation into two on the specified date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Allocation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_allocations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"split_date","in":"query","schemaId":"schema_368","description":"The date on which the allocation splits, in YYYY-MM-DD format. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.","required":true},{"name":"workspace_allocation_id","in":"query","schemaId":"schema_313","description":"The ID of the allocation. This can be found via the [Fetch Workspace Allocations endpoint](/tag/Workspace-Allocations#operation/get-workspace-allocations).","required":true},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User)\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `updater` (User)\n- `workspace` (Workspace) - The workspace that the resource is allocated in.\n- `workspace_resource` (WorkspaceResource)."}],"pointer":"/paths/~1workspace_allocations~1split/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspace_allocations/split","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"split_date","in":"query","required":true,"schemaId":"schema_368"},{"name":"workspace_allocation_id","in":"query","required":true,"schemaId":"schema_313"},{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_allocations/split","href":"workspace-allocations/split workspace allocation by date","openApiOperationId":"Split Workspace Allocation By Date","summary":"Splitting an Allocation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Allocation has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_487"}},"schemaId":"schema_487"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_allocations~1split/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_487","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_487"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_allocations/split"},{"label":"Fetching a single Workspace Allocation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-allocations/get workspace allocation","routeSlug":"/kantata/specification/workspace-allocations/get workspace allocation","metadata":{"seo":{"title":"Fetching a single Workspace Allocation","description":"This endpoint returns structured Workspace Allocation objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_allocations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Allocation","name":"Fetching a single Workspace Allocation","isWebhook":false,"pointer":"/paths/~1workspace_allocations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Workspace Allocation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Allocation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_allocations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_allocations~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User)\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `updater` (User)\n- `workspace` (Workspace) - The workspace that the resource is allocated in.\n- `workspace_resource` (WorkspaceResource)."}],"pointer":"/paths/~1workspace_allocations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_allocations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_allocations/{id}","href":"workspace-allocations/get workspace allocation","openApiOperationId":"Get Workspace Allocation","summary":"Fetching a single Workspace Allocation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Workspace Allocation has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_487"}},"schemaId":"schema_487"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_allocations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_487","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_487"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_allocations/{id}"},{"label":"Updating an existing Workspace Allocation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-allocations/update workspace allocation","routeSlug":"/kantata/specification/workspace-allocations/update workspace allocation","metadata":{"seo":{"title":"Updating an existing Workspace Allocation","description":"This endpoint returns structured Workspace Allocation objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_allocations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workspace Allocation","name":"Updating an existing Workspace Allocation","isWebhook":false,"pointer":"/paths/~1workspace_allocations~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Workspace Allocation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Allocation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_allocations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_allocations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User)\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `updater` (User)\n- `workspace` (Workspace) - The workspace that the resource is allocated in.\n- `workspace_resource` (WorkspaceResource)."}],"pointer":"/paths/~1workspace_allocations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_489"}},"schemaId":"schema_489","pointer":"/paths/~1workspace_allocations~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspace_allocations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_489"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_allocations/{id}","href":"workspace-allocations/update workspace allocation","openApiOperationId":"Update Workspace Allocation","summary":"Updating an existing Workspace Allocation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_489","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_489"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Allocation has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_487"}},"schemaId":"schema_487"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_allocations~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_487","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_487"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_allocations/{id}"},{"label":"Deleting an existing Workspace Allocation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-allocations/delete workspace allocation","routeSlug":"/kantata/specification/workspace-allocations/delete workspace allocation","metadata":{"seo":{"title":"Deleting an existing Workspace Allocation","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Workspace Allocation","name":"Deleting an existing Workspace Allocation","isWebhook":false,"pointer":"/paths/~1workspace_allocations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Workspace Allocation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_allocations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workspace_allocations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/workspace_allocations/{id}","href":"workspace-allocations/delete workspace allocation","openApiOperationId":"Delete Workspace Allocation","summary":"Deleting an existing Workspace Allocation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Workspace Allocation has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_allocations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_allocations/{id}"}],"content":{"contentType":"group","meta":{"name":"Workspace Allocations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workspace Allocations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A workspace allocation represents a resource’s allocation over a specific period of time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A workspace allocation is always associate with a workspace resource."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workspace_allocations","summary":"Fetching a list of Workspace Allocations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-allocations/get workspace allocations","deprecated":false},{"title":"/workspace_allocations","summary":"Creating a new Workspace Allocation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workspace-allocations/create workspace allocation","deprecated":false},{"title":"/workspace_allocations/split","summary":"Splitting an Allocation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspace-allocations/split workspace allocation by date","deprecated":false},{"title":"/workspace_allocations/{id}","summary":"Fetching a single Workspace Allocation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-allocations/get workspace allocation","deprecated":false},{"title":"/workspace_allocations/{id}","summary":"Updating an existing Workspace Allocation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspace-allocations/update workspace allocation","deprecated":false},{"title":"/workspace_allocations/{id}","summary":"Deleting an existing Workspace Allocation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workspace-allocations/delete workspace allocation","deprecated":false}]}]}]}]}},{"type":"group","label":"Workspace Baselines","link":"/kantata/specification/workspace-baselines","routeSlug":"/kantata/specification/workspace-baselines","items":[{"label":"Fetching a list of Workspace Baselines","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-baselines/get workspace baselines","routeSlug":"/kantata/specification/workspace-baselines/get workspace baselines","metadata":{"seo":{"title":"Fetching a list of Workspace Baselines","description":"Returns a list of Gantt workspace baselines associated with workspaces (projects) that are visible to the authenticated user.Visibility restrictions on projects are detailed in the Workspaces API documentation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Baselines","name":"Fetching a list of Workspace Baselines","isWebhook":false,"pointer":"/paths/~1workspace_baselines/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Workspace Baselines","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of Gantt workspace baselines associated with workspaces (projects) that are visible to the authenticated user."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility restrictions on projects are detailed in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Workspaces"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workspaces API documentation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Baseline objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_baselines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user who created this workspace baseline.\n- `payload` (BaselinePayload) - The baseline payload associated with this workspace baseline.\n- `workspace` (Workspace) - The workspace represented in this workspace baseline."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Filter baselines by workspace ID."}],"pointer":"/paths/~1workspace_baselines/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_baselines","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_baselines","href":"workspace-baselines/get workspace baselines","openApiOperationId":"Get Workspace Baselines","summary":"Fetching a list of Workspace Baselines"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Workspace Baselines have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_490"}},"schemaId":"schema_490"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_baselines/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_490","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_490"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_baselines"},{"label":"Creating a new Workspace Baseline","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-baselines/create workspace baseline","routeSlug":"/kantata/specification/workspace-baselines/create workspace baseline","metadata":{"seo":{"title":"Creating a new Workspace Baseline","description":"Creates a Gantt workspace baseline for a specified workspace (project). The baseline will contain aggregate statistics and certain data about each story (task)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workspace Baseline","name":"Creating a new Workspace Baseline","isWebhook":false,"pointer":"/paths/~1workspace_baselines/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Workspace Baseline","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a Gantt workspace baseline for a specified workspace (project). The baseline will contain aggregate statistics and certain data about each story (task)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Baseline objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_baselines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user who created this workspace baseline.\n- `payload` (BaselinePayload) - The baseline payload associated with this workspace baseline.\n- `workspace` (Workspace) - The workspace represented in this workspace baseline."}],"pointer":"/paths/~1workspace_baselines/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_491"}},"schemaId":"schema_491","pointer":"/paths/~1workspace_baselines/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workspace_baselines","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_491"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_baselines","href":"workspace-baselines/create workspace baseline","openApiOperationId":"Create Workspace Baseline","summary":"Creating a new Workspace Baseline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_491","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_491"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Baseline has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_490"}},"schemaId":"schema_490"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_baselines/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_490","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_490"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_baselines"},{"label":"Fetching a single Workspace Baseline","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-baselines/get workspace baseline","routeSlug":"/kantata/specification/workspace-baselines/get workspace baseline","metadata":{"seo":{"title":"Fetching a single Workspace Baseline","description":"Returns a specified Gantt workspace baseline."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Baseline","name":"Fetching a single Workspace Baseline","isWebhook":false,"pointer":"/paths/~1workspace_baselines~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Workspace Baseline","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a specified Gantt workspace baseline."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Baseline objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_baselines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_baselines~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user who created this workspace baseline.\n- `payload` (BaselinePayload) - The baseline payload associated with this workspace baseline.\n- `workspace` (Workspace) - The workspace represented in this workspace baseline."}],"pointer":"/paths/~1workspace_baselines~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_baselines/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_baselines/{id}","href":"workspace-baselines/get workspace baseline","openApiOperationId":"Get Workspace Baseline","summary":"Fetching a single Workspace Baseline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Workspace Baseline has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_490"}},"schemaId":"schema_490"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_baselines~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_490","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_490"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_baselines/{id}"},{"label":"Updating an existing Workspace Baseline","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-baselines/update workspace baseline","routeSlug":"/kantata/specification/workspace-baselines/update workspace baseline","metadata":{"seo":{"title":"Updating an existing Workspace Baseline","description":"Updates a specified Gantt workspace baseline."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workspace Baseline","name":"Updating an existing Workspace Baseline","isWebhook":false,"pointer":"/paths/~1workspace_baselines~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Workspace Baseline","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a specified Gantt workspace baseline."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Baseline objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_baselines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_baselines~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user who created this workspace baseline.\n- `payload` (BaselinePayload) - The baseline payload associated with this workspace baseline.\n- `workspace` (Workspace) - The workspace represented in this workspace baseline."}],"pointer":"/paths/~1workspace_baselines~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_491"}},"schemaId":"schema_491","pointer":"/paths/~1workspace_baselines~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspace_baselines/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_491"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_baselines/{id}","href":"workspace-baselines/update workspace baseline","openApiOperationId":"Update Workspace Baseline","summary":"Updating an existing Workspace Baseline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_491","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_491"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Baseline has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_490"}},"schemaId":"schema_490"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_baselines~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_490","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_490"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_baselines/{id}"},{"label":"Deleting an existing Workspace Baseline","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-baselines/delete workspace baseline","routeSlug":"/kantata/specification/workspace-baselines/delete workspace baseline","metadata":{"seo":{"title":"Deleting an existing Workspace Baseline","description":"Deletes a specified Gantt workspace baseline."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Workspace Baseline","name":"Deleting an existing Workspace Baseline","isWebhook":false,"pointer":"/paths/~1workspace_baselines~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Workspace Baseline","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a specified Gantt workspace baseline."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_baselines~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workspace_baselines/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/workspace_baselines/{id}","href":"workspace-baselines/delete workspace baseline","openApiOperationId":"Delete Workspace Baseline","summary":"Deleting an existing Workspace Baseline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Workspace Baseline has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_baselines~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_baselines/{id}"}],"content":{"contentType":"group","meta":{"name":"Workspace Baselines"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workspace Baselines","showPageActions":true},{"nodeType":"markdoc","content":"A Gantt workspace baseline is a snapshot of a workspace at a particular point in time.\nThe snapshot contains aggregate statistics and certain data about each story (task)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workspace_baselines","summary":"Fetching a list of Workspace Baselines","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-baselines/get workspace baselines","deprecated":false},{"title":"/workspace_baselines","summary":"Creating a new Workspace Baseline","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workspace-baselines/create workspace baseline","deprecated":false},{"title":"/workspace_baselines/{id}","summary":"Fetching a single Workspace Baseline","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-baselines/get workspace baseline","deprecated":false},{"title":"/workspace_baselines/{id}","summary":"Updating an existing Workspace Baseline","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspace-baselines/update workspace baseline","deprecated":false},{"title":"/workspace_baselines/{id}","summary":"Deleting an existing Workspace Baseline","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workspace-baselines/delete workspace baseline","deprecated":false}]}]}]}]}},{"type":"group","label":"Workspace Groups","link":"/kantata/specification/workspace-groups","routeSlug":"/kantata/specification/workspace-groups","items":[{"label":"Fetching a list of Workspace Groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-groups/get workspace groups","routeSlug":"/kantata/specification/workspace-groups/get workspace groups","metadata":{"seo":{"title":"Fetching a list of Workspace Groups","description":"This endpoint returns structured Workspace Group objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_groups top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Groups","name":"Fetching a list of Workspace Groups","isWebhook":false,"pointer":"/paths/~1workspace_groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Workspace Groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Group objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field choice value, represented as a string with the custom field ID, followed by a\ncolon, and then comma-separated custom field choice value IDs. The custom field choice value can also be\nthe word `blank`. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\n\nThe following formats are supported:\n\n- `custom_field_ID:choice_value_ID`\n- `custom_field_ID:choice_value_1_ID,choice_value_2_ID`\n- `custom_field_ID:blank`\n- `(custom_field_1_ID:choice_value_1_ID,choice_value_2_ID):(custom_field_2_ID:choice_value_3_ID)`."},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field currency value, represented as a string with the custom field ID, followed by a\ncolon, and then the currency value. Optionally, the currency [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473) can be supplied as well, separated\nfrom the currency value by another colon. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200.2:USD):(2:100)`."},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field date value, represented as a string with the custom field ID, followed by a\ncolon, the starting date, another colon, and then the ending date. You can provide both a starting date\nand ending date, or provide just one. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:2014-12-05:2014-12-25):(2:2014-12-05)`."},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field number value, represented as a string with the custom field ID, followed by a\ncolon, and then the number value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200):(2:101)`."},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field text value, represented as a string with the custom field ID, followed by a\ncolon, and then the text value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:something):(2:else)`\n- `(1:something):(1:else)` (multiple values for the same field, returns objects matching any value)\n- `1` (bare field ID with no value, returns all objects that have any value for that field)."},{"name":"companies_only","in":"query","schemaId":"schema_305","description":"Filter by groups that represent a company."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304","description":"Filter by the presence of a custom field value for the specified comma-separated custom field ID(s)."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `rate_card_sets` (RateCardSet) - Rate Card Sets associated with the group.\n- `workspaces` (Workspace) - Workspaces associated with the group."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Filter by groups that have a name similar to the supplied string."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_492","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `name:asc`, `name:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1workspace_groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_groups","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304"},{"name":"companies_only","in":"query","schemaId":"schema_305"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_492"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_groups","href":"workspace-groups/get workspace groups","openApiOperationId":"Get Workspace Groups","summary":"Fetching a list of Workspace Groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Workspace Groups have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_493"}},"schemaId":"schema_493"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_493","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_493"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_groups"},{"label":"Creating a new Workspace Group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-groups/create workspace group","routeSlug":"/kantata/specification/workspace-groups/create workspace group","metadata":{"seo":{"title":"Creating a new Workspace Group","description":"This endpoint returns structured Workspace Group objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_groups top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workspace Group","name":"Creating a new Workspace Group","isWebhook":false,"pointer":"/paths/~1workspace_groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Workspace Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Group objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `rate_card_sets` (RateCardSet) - Rate Card Sets associated with the group.\n- `workspaces` (Workspace) - Workspaces associated with the group."}],"pointer":"/paths/~1workspace_groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_494"}},"schemaId":"schema_494","pointer":"/paths/~1workspace_groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workspace_groups","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_494"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_groups","href":"workspace-groups/create workspace group","openApiOperationId":"Create Workspace Group","summary":"Creating a new Workspace Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_494","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_494"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Group has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_493"}},"schemaId":"schema_493"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_groups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_493","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_493"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_groups"},{"label":"Fetching a single Workspace Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-groups/get workspace group","routeSlug":"/kantata/specification/workspace-groups/get workspace group","metadata":{"seo":{"title":"Fetching a single Workspace Group","description":"This endpoint returns structured Workspace Group objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_groups top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Group","name":"Fetching a single Workspace Group","isWebhook":false,"pointer":"/paths/~1workspace_groups~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Workspace Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Group objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_groups~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `rate_card_sets` (RateCardSet) - Rate Card Sets associated with the group.\n- `workspaces` (Workspace) - Workspaces associated with the group."}],"pointer":"/paths/~1workspace_groups~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_groups/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_groups/{id}","href":"workspace-groups/get workspace group","openApiOperationId":"Get Workspace Group","summary":"Fetching a single Workspace Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Workspace Group has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_493"}},"schemaId":"schema_493"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_groups~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_493","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_493"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_groups/{id}"},{"label":"Updating an existing Workspace Group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-groups/update workspace group","routeSlug":"/kantata/specification/workspace-groups/update workspace group","metadata":{"seo":{"title":"Updating an existing Workspace Group","description":"This endpoint returns structured Workspace Group objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_groups top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workspace Group","name":"Updating an existing Workspace Group","isWebhook":false,"pointer":"/paths/~1workspace_groups~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Workspace Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Group objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_groups~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `rate_card_sets` (RateCardSet) - Rate Card Sets associated with the group.\n- `workspaces` (Workspace) - Workspaces associated with the group."}],"pointer":"/paths/~1workspace_groups~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_495"}},"schemaId":"schema_495","pointer":"/paths/~1workspace_groups~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspace_groups/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_495"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_groups/{id}","href":"workspace-groups/update workspace group","openApiOperationId":"Update Workspace Group","summary":"Updating an existing Workspace Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_495","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_495"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Group has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_493"}},"schemaId":"schema_493"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_groups~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_493","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_493"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_groups/{id}"},{"label":"Deleting an existing Workspace Group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-groups/delete workspace group","routeSlug":"/kantata/specification/workspace-groups/delete workspace group","metadata":{"seo":{"title":"Deleting an existing Workspace Group","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Workspace Group","name":"Deleting an existing Workspace Group","isWebhook":false,"pointer":"/paths/~1workspace_groups~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Workspace Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_groups~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workspace_groups/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/workspace_groups/{id}","href":"workspace-groups/delete workspace group","openApiOperationId":"Delete Workspace Group","summary":"Deleting an existing Workspace Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Workspace Group has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_groups~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_groups/{id}"}],"content":{"contentType":"group","meta":{"name":"Workspace Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workspace Groups","showPageActions":true},{"nodeType":"markdoc","content":"Workspace Groups (also known as groups) allow for the categorization of Kantata OX Workspaces. Workspace Groups are unique to each Kantata OX Account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workspace_groups","summary":"Fetching a list of Workspace Groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-groups/get workspace groups","deprecated":false},{"title":"/workspace_groups","summary":"Creating a new Workspace Group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workspace-groups/create workspace group","deprecated":false},{"title":"/workspace_groups/{id}","summary":"Fetching a single Workspace Group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-groups/get workspace group","deprecated":false},{"title":"/workspace_groups/{id}","summary":"Updating an existing Workspace Group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspace-groups/update workspace group","deprecated":false},{"title":"/workspace_groups/{id}","summary":"Deleting an existing Workspace Group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workspace-groups/delete workspace group","deprecated":false}]}]}]}]}},{"type":"group","label":"Workspace Invoice Preferences","link":"/kantata/specification/workspace-invoice-preferences","routeSlug":"/kantata/specification/workspace-invoice-preferences","items":[{"label":"Creating a new Workspace Invoice Preference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-invoice-preferences/create workspace invoice preferences","routeSlug":"/kantata/specification/workspace-invoice-preferences/create workspace invoice preferences","metadata":{"seo":{"title":"Creating a new Workspace Invoice Preference","description":"This endpoint returns structured Workspace Invoice Preference objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_invoice_preferences top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workspace Invoice Preferences","name":"Creating a new Workspace Invoice Preference","isWebhook":false,"pointer":"/paths/~1workspace_invoice_preferences/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Workspace Invoice Preference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Invoice Preference objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_invoice_preferences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_453"}},"schemaId":"schema_453","pointer":"/paths/~1workspace_invoice_preferences/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workspace_invoice_preferences","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_453"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_invoice_preferences","href":"workspace-invoice-preferences/create workspace invoice preferences","openApiOperationId":"Create Workspace Invoice Preferences","summary":"Creating a new Workspace Invoice Preference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_453","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_453"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Invoice Preference has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}},"schemaId":"schema_454"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_invoice_preferences/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_454","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_invoice_preferences"},{"label":"Fetching a single Workspace Invoice Preference","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-invoice-preferences/get workspace invoice preferences","routeSlug":"/kantata/specification/workspace-invoice-preferences/get workspace invoice preferences","metadata":{"seo":{"title":"Fetching a single Workspace Invoice Preference","description":"This endpoint returns structured Workspace Invoice Preference objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_invoice_preferences top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Invoice Preferences","name":"Fetching a single Workspace Invoice Preference","isWebhook":false,"pointer":"/paths/~1workspace_invoice_preferences~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Workspace Invoice Preference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Invoice Preference objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_invoice_preferences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_invoice_preferences~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_invoice_preferences/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_invoice_preferences/{id}","href":"workspace-invoice-preferences/get workspace invoice preferences","openApiOperationId":"Get Workspace Invoice Preferences","summary":"Fetching a single Workspace Invoice Preference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Workspace Invoice Preference has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}},"schemaId":"schema_454"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_invoice_preferences~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_454","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_invoice_preferences/{id}"},{"label":"Updating an existing Workspace Invoice Preference","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-invoice-preferences/update workspace invoice preferences","routeSlug":"/kantata/specification/workspace-invoice-preferences/update workspace invoice preferences","metadata":{"seo":{"title":"Updating an existing Workspace Invoice Preference","description":"This endpoint returns structured Workspace Invoice Preference objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_invoice_preferences top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workspace Invoice Preferences","name":"Updating an existing Workspace Invoice Preference","isWebhook":false,"pointer":"/paths/~1workspace_invoice_preferences~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Workspace Invoice Preference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Invoice Preference objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_invoice_preferences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_invoice_preferences~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_455"}},"schemaId":"schema_455","pointer":"/paths/~1workspace_invoice_preferences~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspace_invoice_preferences/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_455"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_invoice_preferences/{id}","href":"workspace-invoice-preferences/update workspace invoice preferences","openApiOperationId":"Update Workspace Invoice Preferences","summary":"Updating an existing Workspace Invoice Preference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_455","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_455"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Invoice Preference has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}},"schemaId":"schema_454"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_invoice_preferences~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_454","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_invoice_preferences/{id}"}],"content":{"contentType":"group","meta":{"name":"Workspace Invoice Preferences"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workspace Invoice Preferences","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workspace Invoice Preferences specify the default values that are applied to new invoices created for the specified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"project. It is only used for projects that have financials enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These preferences can only be created and updated by users who can manage invoice preferences"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the project. This can be found by querying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"can_manage_invoice_preferences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on Workspace."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workspace_invoice_preferences","summary":"Creating a new Workspace Invoice Preference","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workspace-invoice-preferences/create workspace invoice preferences","deprecated":false},{"title":"/workspace_invoice_preferences/{id}","summary":"Fetching a single Workspace Invoice Preference","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-invoice-preferences/get workspace invoice preferences","deprecated":false},{"title":"/workspace_invoice_preferences/{id}","summary":"Updating an existing Workspace Invoice Preference","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspace-invoice-preferences/update workspace invoice preferences","deprecated":false}]}]}]}]}},{"type":"group","label":"Workspace Resource Skills","link":"/kantata/specification/workspace-resource-skills","routeSlug":"/kantata/specification/workspace-resource-skills","items":[{"label":"Fetching a list of Workspace Resource Skills","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-resource-skills/get workspace resource skills","routeSlug":"/kantata/specification/workspace-resource-skills/get workspace resource skills","metadata":{"seo":{"title":"Fetching a list of Workspace Resource Skills","description":"Returns a list of Workspace Resource Skills that represent the skills associated with workspaceresources visible to the logged in user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Resource Skills","name":"Fetching a list of Workspace Resource Skills","isWebhook":false,"pointer":"/paths/~1workspace_resource_skills/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Workspace Resource Skills","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of Workspace Resource Skills that represent the skills associated with workspace"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resources visible to the logged in user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Resource Skill objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_resource_skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"by_skill_id","in":"query","schemaId":"schema_313","description":"Only includes associated skill, by the skill ID."},{"name":"by_skill_ids","in":"query","schemaId":"schema_304","description":"Only includes associated skills. Input is a comma separated list of ids or an array."},{"name":"by_skill_name","in":"query","schemaId":"schema_304","description":"Only includes associated skills, by the name of the skill."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - References the user who has created the skill association.\n- `skill` (Skill) - References the skill assigned to the object.\n- `workspace_resource` (WorkspaceResource) - References the workspace resource who has been assigned the skill."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `skill_name:asc`, and `skill_name:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"workspace_resource_ids","in":"query","schemaId":"schema_352","description":"Only includes workspace resource skills assigned to a workspace resource, by workspace resource ID."}],"pointer":"/paths/~1workspace_resource_skills/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_resource_skills","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"by_skill_id","in":"query","schemaId":"schema_313"},{"name":"by_skill_ids","in":"query","schemaId":"schema_304"},{"name":"by_skill_name","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"workspace_resource_ids","in":"query","schemaId":"schema_352","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_resource_skills","href":"workspace-resource-skills/get workspace resource skills","openApiOperationId":"Get Workspace Resource Skills","summary":"Fetching a list of Workspace Resource Skills"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Workspace Resource Skills have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_496"}},"schemaId":"schema_496"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_resource_skills/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_496","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_496"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_resource_skills"},{"label":"Creating a new Workspace Resource Skill","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-resource-skills/create workspace resource skill","routeSlug":"/kantata/specification/workspace-resource-skills/create workspace resource skill","metadata":{"seo":{"title":"Creating a new Workspace Resource Skill","description":"This endpoint returns structured Workspace Resource Skill objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_resource_skills top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workspace Resource Skill","name":"Creating a new Workspace Resource Skill","isWebhook":false,"pointer":"/paths/~1workspace_resource_skills/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Workspace Resource Skill","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Resource Skill objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_resource_skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - References the user who has created the skill association.\n- `skill` (Skill) - References the skill assigned to the object.\n- `workspace_resource` (WorkspaceResource) - References the workspace resource who has been assigned the skill."}],"pointer":"/paths/~1workspace_resource_skills/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_497"}},"schemaId":"schema_497","pointer":"/paths/~1workspace_resource_skills/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workspace_resource_skills","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_497"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_resource_skills","href":"workspace-resource-skills/create workspace resource skill","openApiOperationId":"Create Workspace Resource Skill","summary":"Creating a new Workspace Resource Skill"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_497","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_497"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Resource Skill has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_496"}},"schemaId":"schema_496"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_resource_skills/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_496","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_496"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_resource_skills"},{"label":"Fetching a single Workspace Resource Skill","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-resource-skills/get workspace resource skill","routeSlug":"/kantata/specification/workspace-resource-skills/get workspace resource skill","metadata":{"seo":{"title":"Fetching a single Workspace Resource Skill","description":"This endpoint returns structured Workspace Resource Skill objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_resource_skills top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Resource Skill","name":"Fetching a single Workspace Resource Skill","isWebhook":false,"pointer":"/paths/~1workspace_resource_skills~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Workspace Resource Skill","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Resource Skill objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_resource_skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_resource_skills~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - References the user who has created the skill association.\n- `skill` (Skill) - References the skill assigned to the object.\n- `workspace_resource` (WorkspaceResource) - References the workspace resource who has been assigned the skill."}],"pointer":"/paths/~1workspace_resource_skills~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_resource_skills/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_resource_skills/{id}","href":"workspace-resource-skills/get workspace resource skill","openApiOperationId":"Get Workspace Resource Skill","summary":"Fetching a single Workspace Resource Skill"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Workspace Resource Skill has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_496"}},"schemaId":"schema_496"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_resource_skills~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_496","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_496"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_resource_skills/{id}"},{"label":"Updating an existing Workspace Resource Skill","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-resource-skills/update workspace resource skill","routeSlug":"/kantata/specification/workspace-resource-skills/update workspace resource skill","metadata":{"seo":{"title":"Updating an existing Workspace Resource Skill","description":"This endpoint returns structured Workspace Resource Skill objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_resource_skills top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workspace Resource Skill","name":"Updating an existing Workspace Resource Skill","isWebhook":false,"pointer":"/paths/~1workspace_resource_skills~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Workspace Resource Skill","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Resource Skill objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_resource_skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_resource_skills~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - References the user who has created the skill association.\n- `skill` (Skill) - References the skill assigned to the object.\n- `workspace_resource` (WorkspaceResource) - References the workspace resource who has been assigned the skill."}],"pointer":"/paths/~1workspace_resource_skills~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_498"}},"schemaId":"schema_498","pointer":"/paths/~1workspace_resource_skills~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspace_resource_skills/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_498"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_resource_skills/{id}","href":"workspace-resource-skills/update workspace resource skill","openApiOperationId":"Update Workspace Resource Skill","summary":"Updating an existing Workspace Resource Skill"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_498","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_498"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Resource Skill has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_496"}},"schemaId":"schema_496"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_resource_skills~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_496","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_496"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_resource_skills/{id}"},{"label":"Deleting an existing Workspace Resource Skill","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-resource-skills/delete workspace resource skill","routeSlug":"/kantata/specification/workspace-resource-skills/delete workspace resource skill","metadata":{"seo":{"title":"Deleting an existing Workspace Resource Skill","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Workspace Resource Skill","name":"Deleting an existing Workspace Resource Skill","isWebhook":false,"pointer":"/paths/~1workspace_resource_skills~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Workspace Resource Skill","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_resource_skills~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workspace_resource_skills/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/workspace_resource_skills/{id}","href":"workspace-resource-skills/delete workspace resource skill","openApiOperationId":"Delete Workspace Resource Skill","summary":"Deleting an existing Workspace Resource Skill"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Workspace Resource Skill has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_resource_skills~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_resource_skills/{id}"}],"content":{"contentType":"group","meta":{"name":"Workspace Resource Skills"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workspace Resource Skills","showPageActions":true},{"nodeType":"markdoc","content":"Workspace Resource Skills represent skills that have been assigned to a workspace resource."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workspace_resource_skills","summary":"Fetching a list of Workspace Resource Skills","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-resource-skills/get workspace resource skills","deprecated":false},{"title":"/workspace_resource_skills","summary":"Creating a new Workspace Resource Skill","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workspace-resource-skills/create workspace resource skill","deprecated":false},{"title":"/workspace_resource_skills/{id}","summary":"Fetching a single Workspace Resource Skill","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-resource-skills/get workspace resource skill","deprecated":false},{"title":"/workspace_resource_skills/{id}","summary":"Updating an existing Workspace Resource Skill","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspace-resource-skills/update workspace resource skill","deprecated":false},{"title":"/workspace_resource_skills/{id}","summary":"Deleting an existing Workspace Resource Skill","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workspace-resource-skills/delete workspace resource skill","deprecated":false}]}]}]}]}},{"type":"group","label":"Workspace Resources","link":"/kantata/specification/workspace-resources","routeSlug":"/kantata/specification/workspace-resources","items":[{"type":"link","label":"Primary Project Role","link":"/kantata/specification/workspace-resources/primary-project-role","routeSlug":"/kantata/specification/workspace-resources/primary-project-role","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Primary Project Role"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":5,"id":"workspace-resources/primary-project-role"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary Project Role"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A user's primary project role is defined by role_id on the user's Participation for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workspace if that is set. If role_id is not set on the user's participation, primary project"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"role is defined by default_role_id on the user's account_membership only if the user's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account_membership.account_id matches the workspace.account_id"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(the user belongs to the project's account)."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Fetching a list of Workspace Resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-resources/get workspace resources","routeSlug":"/kantata/specification/workspace-resources/get workspace resources","metadata":{"seo":{"title":"Fetching a list of Workspace Resources","description":"This endpoint returns structured Workspace Resource objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_resources top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Resources","name":"Fetching a list of Workspace Resources","isWebhook":false,"pointer":"/paths/~1workspace_resources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Workspace Resources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Resource objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field choice value, represented as a string with the custom field ID, followed by a\ncolon, and then comma-separated custom field choice value IDs. The custom field choice value can also be\nthe word `blank`. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\n\nThe following formats are supported:\n\n- `custom_field_ID:choice_value_ID`\n- `custom_field_ID:choice_value_1_ID,choice_value_2_ID`\n- `custom_field_ID:blank`\n- `(custom_field_1_ID:choice_value_1_ID,choice_value_2_ID):(custom_field_2_ID:choice_value_3_ID)`."},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field currency value, represented as a string with the custom field ID, followed by a\ncolon, and then the currency value. Optionally, the currency [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473) can be supplied as well, separated\nfrom the currency value by another colon. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200.2:USD):(2:100)`."},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field date value, represented as a string with the custom field ID, followed by a\ncolon, the starting date, another colon, and then the ending date. You can provide both a starting date\nand ending date, or provide just one. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:2014-12-05:2014-12-25):(2:2014-12-05)`."},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field number value, represented as a string with the custom field ID, followed by a\ncolon, and then the number value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200):(2:101)`."},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field text value, represented as a string with the custom field ID, followed by a\ncolon, and then the text value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:something):(2:else)`\n- `(1:something):(1:else)` (multiple values for the same field, returns objects matching any value)\n- `1` (bare field ID with no value, returns all objects that have any value for that field)."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304","description":"Filter by the presence of a custom field value for the specified comma-separated custom field ID(s)."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_field_values` (CustomFieldValue) - Retrieves the custom field values for the resource. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.\n- `participation` (Participation) - Retrieves the participation associated with the resource. The response will include `participation_id`, which references the data in the `participations` top-level key.\n- `role` (Role) - Retrieves the role for this resource. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Retrieves the user associated with the resource. The response will include `user_id`, which references the data in the `users` top-level key. For unnamed resources, the `user_id` will be `null`.\n- `workspace` (Workspace) - Retrieves the workspace (project) the resource is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"include_unnamed","in":"query","schemaId":"schema_305","description":"Returns Unnamed Resources in addition to Named Resources."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Show Resources associated with a User that matches the specified parameter or has a Role that matches the specified parameter."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"only_unnamed","in":"query","schemaId":"schema_305","description":"Returns only Unnamed Resources."},{"name":"optional_fields","in":"query","schemaId":"schema_499","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `alphabetical`, `alphabetically:asc`, `alphabetically:desc`, `created_at:asc`, `created_at:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"potential_workspace_resource_for_story_with_unnamed_resources","in":"query","schemaId":"schema_313","description":"Takes a Reference to a Story Id. Show only Resources that are available to assign for specified Story."},{"name":"potential_workspace_resources_for_reassignment","in":"query","schemaId":"schema_313","description":"Takes an Assignment Id. Shows only Resources that can be reassigned to the specified assignment."},{"name":"potential_workspace_resources_for_story","in":"query","schemaId":"schema_313","description":"Takes a Reference to a Story Id Show only Resources that have an user assigned, and are available to assign for specified Story."},{"name":"providers","in":"query","schemaId":"schema_305","description":"Show only Resources that have an user assigned, and are consultants in the workspace."},{"name":"providers_with_unnamed","in":"query","schemaId":"schema_305","description":"Show only Resources that have consultant users or no users at all."},{"name":"role_id","in":"query","schemaId":"schema_313","description":"Returns workspace resources for a specified role in a workspace. Returns workspace resources for a specified role when only the role is provided."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"user_id","in":"query","schemaId":"schema_313","description":"Returns workspace resources for a specified user in a workspace. Returns workspace resources for a specified user when only the user is provided."},{"name":"with_organizations","in":"query","schemaId":"schema_305","description":"Only includes Resources that have an organization (true) or only includes Resources that do not have an organization (false)."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Id for a specified workspace you wish to retrieve."}],"pointer":"/paths/~1workspace_resources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_resources","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"include_unnamed","in":"query","required":false,"schemaId":"schema_305"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"only_unnamed","in":"query","required":false,"schemaId":"schema_305"},{"name":"optional_fields","in":"query","schemaId":"schema_499","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"potential_workspace_resource_for_story_with_unnamed_resources","in":"query","schemaId":"schema_313"},{"name":"potential_workspace_resources_for_reassignment","in":"query","schemaId":"schema_313"},{"name":"potential_workspace_resources_for_story","in":"query","schemaId":"schema_313"},{"name":"providers","in":"query","schemaId":"schema_305"},{"name":"providers_with_unnamed","in":"query","schemaId":"schema_305"},{"name":"role_id","in":"query","required":false,"schemaId":"schema_313"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"user_id","in":"query","required":false,"schemaId":"schema_313"},{"name":"with_organizations","in":"query","schemaId":"schema_305"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","required":false,"schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_resources","href":"workspace-resources/get workspace resources","openApiOperationId":"Get Workspace Resources","summary":"Fetching a list of Workspace Resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Workspace Resources have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_500"}},"schemaId":"schema_500"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_resources/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_500"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_resources"},{"label":"Creating a new Workspace Resource","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-resources/create workspace resource","routeSlug":"/kantata/specification/workspace-resources/create workspace resource","metadata":{"seo":{"title":"Creating a new Workspace Resource","description":"Adds a named or unnamed resource to a project (workspace)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workspace Resource","name":"Creating a new Workspace Resource","isWebhook":false,"pointer":"/paths/~1workspace_resources/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Workspace Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a named or unnamed resource to a project (workspace)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 200 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"workspace_resources\": [\n {\n \"workspace_id\": 123,\n \"user_id\": 111,\n \"role_id\": 555\n },\n {\n \"workspace_id\": 123,\n \"user_id\": 222,\n \"role_id\": 666\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"workspace_resources\": [\n {\n \"workspace_id\": 123,\n \"user_id\": 111,\n \"role_id\": 555\n },\n {\n \"workspace_id\": 123,\n \"user_id\": 222,\n \"role_id\": 666\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Resource objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_field_values` (CustomFieldValue) - Retrieves the custom field values for the resource. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.\n- `participation` (Participation) - Retrieves the participation associated with the resource. The response will include `participation_id`, which references the data in the `participations` top-level key.\n- `role` (Role) - Retrieves the role for this resource. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Retrieves the user associated with the resource. The response will include `user_id`, which references the data in the `users` top-level key. For unnamed resources, the `user_id` will be `null`.\n- `workspace` (Workspace) - Retrieves the workspace (project) the resource is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_499","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspace_resources/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_501"}},"schemaId":"schema_501","pointer":"/paths/~1workspace_resources/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workspace_resources","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_499","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_501"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_resources","href":"workspace-resources/create workspace resource","openApiOperationId":"Create Workspace Resource","summary":"Creating a new Workspace Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_501","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_501"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Resource has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_500"}},"schemaId":"schema_500"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_resources/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_500"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_resources"},{"label":"Creating Allocations from Scheduled Hours for Resources","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-resources/create workspace resource allocations from scheduled hours","routeSlug":"/kantata/specification/workspace-resources/create workspace resource allocations from scheduled hours","metadata":{"seo":{"title":"Creating Allocations from Scheduled Hours for Resources","description":"This will create allocations for workspace resources based on their scheduled hours.This endpoint is only usable for Account Administrators and users with Users can edit allocations for unnamed resources or Users can edit allocations for named resourcesaccess in the Edit Allocations section of the Resource Management Access Group Set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workspace Resource Allocations From Scheduled Hours","name":"Creating Allocations from Scheduled Hours for Resources","isWebhook":false,"pointer":"/paths/~1workspace_resources~1allocations_matching_scheduled_hours/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating Allocations from Scheduled Hours for Resources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will create allocations for workspace resources based on their scheduled hours."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is only usable for Account Administrators and users with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Users can edit allocations for unnamed resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Users can edit allocations for named resources"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Edit Allocations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Resource Management"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Access Group Set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Resource objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_field_values` (CustomFieldValue) - Retrieves the custom field values for the resource. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.\n- `participation` (Participation) - Retrieves the participation associated with the resource. The response will include `participation_id`, which references the data in the `participations` top-level key.\n- `role` (Role) - Retrieves the role for this resource. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Retrieves the user associated with the resource. The response will include `user_id`, which references the data in the `users` top-level key. For unnamed resources, the `user_id` will be `null`.\n- `workspace` (Workspace) - Retrieves the workspace (project) the resource is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_499","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspace_resources~1allocations_matching_scheduled_hours/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_502"}},"schemaId":"schema_502","pointer":"/paths/~1workspace_resources~1allocations_matching_scheduled_hours/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workspace_resources/allocations_matching_scheduled_hours","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_499","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_502"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_resources/allocations_matching_scheduled_hours","href":"workspace-resources/create workspace resource allocations from scheduled hours","openApiOperationId":"Create Workspace Resource Allocations From Scheduled Hours","summary":"Creating Allocations from Scheduled Hours for Resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_502","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_502"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Resource has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_503"}},"schemaId":"schema_503"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_resources~1allocations_matching_scheduled_hours/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_503","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_503"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_resources/allocations_matching_scheduled_hours"},{"label":"Fetching a single Workspace Resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-resources/get workspace resource","routeSlug":"/kantata/specification/workspace-resources/get workspace resource","metadata":{"seo":{"title":"Fetching a single Workspace Resource","description":"This endpoint returns structured Workspace Resource objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_resources top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Resource","name":"Fetching a single Workspace Resource","isWebhook":false,"pointer":"/paths/~1workspace_resources~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Workspace Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Resource objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_resources~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_field_values` (CustomFieldValue) - Retrieves the custom field values for the resource. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.\n- `participation` (Participation) - Retrieves the participation associated with the resource. The response will include `participation_id`, which references the data in the `participations` top-level key.\n- `role` (Role) - Retrieves the role for this resource. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Retrieves the user associated with the resource. The response will include `user_id`, which references the data in the `users` top-level key. For unnamed resources, the `user_id` will be `null`.\n- `workspace` (Workspace) - Retrieves the workspace (project) the resource is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_499","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspace_resources~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_resources/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_499","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_resources/{id}","href":"workspace-resources/get workspace resource","openApiOperationId":"Get Workspace Resource","summary":"Fetching a single Workspace Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Workspace Resource has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_500"}},"schemaId":"schema_500"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_resources~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_500"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_resources/{id}"},{"label":"Updating an existing Workspace Resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-resources/update workspace resource","routeSlug":"/kantata/specification/workspace-resources/update workspace resource","metadata":{"seo":{"title":"Updating an existing Workspace Resource","description":"This endpoint returns structured Workspace Resource objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_resources top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workspace Resource","name":"Updating an existing Workspace Resource","isWebhook":false,"pointer":"/paths/~1workspace_resources~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Workspace Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Resource objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_resources~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_field_values` (CustomFieldValue) - Retrieves the custom field values for the resource. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.\n- `participation` (Participation) - Retrieves the participation associated with the resource. The response will include `participation_id`, which references the data in the `participations` top-level key.\n- `role` (Role) - Retrieves the role for this resource. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Retrieves the user associated with the resource. The response will include `user_id`, which references the data in the `users` top-level key. For unnamed resources, the `user_id` will be `null`.\n- `workspace` (Workspace) - Retrieves the workspace (project) the resource is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_499","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspace_resources~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_504"}},"schemaId":"schema_504","pointer":"/paths/~1workspace_resources~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspace_resources/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_499","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_504"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_resources/{id}","href":"workspace-resources/update workspace resource","openApiOperationId":"Update Workspace Resource","summary":"Updating an existing Workspace Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_504","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_504"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Resource has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_500"}},"schemaId":"schema_500"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_resources~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_500"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_resources/{id}"},{"label":"Deleting an existing Workspace Resource","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-resources/delete workspace resource","routeSlug":"/kantata/specification/workspace-resources/delete workspace resource","metadata":{"seo":{"title":"Deleting an existing Workspace Resource","description":"This will delete a workspace resource and their assignments if the resource is deletable.A workspace resource is not deletable if it is the last resource for a user's primaryrole within a workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Workspace Resource","name":"Deleting an existing Workspace Resource","isWebhook":false,"pointer":"/paths/~1workspace_resources~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Workspace Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will delete a workspace resource and their assignments if the resource is deletable."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A workspace resource is not deletable if it is the last resource for a user's primary"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"role within a workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_resources~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workspace_resources/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/workspace_resources/{id}","href":"workspace-resources/delete workspace resource","openApiOperationId":"Delete Workspace Resource","summary":"Deleting an existing Workspace Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Workspace Resource has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_resources~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_resources/{id}"},{"label":"Creating Allocations from Scheduled Hours for Resources","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-resources/create workspace resource allocations from scheduled hours by id","routeSlug":"/kantata/specification/workspace-resources/create workspace resource allocations from scheduled hours by id","metadata":{"seo":{"title":"Creating Allocations from Scheduled Hours for Resources","description":"This will create allocations for workspace resources based on their scheduled hours.This endpoint is only usable for Account Administrators and users with Users can edit allocations for unnamed resources or Users can edit allocations for named resourcesaccess in the Edit Allocations section of the Resource Management Access Group Set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workspace Resource Allocations From Scheduled Hours By Id","name":"Creating Allocations from Scheduled Hours for Resources","isWebhook":false,"pointer":"/paths/~1workspace_resources~1{id}~1allocations_matching_scheduled_hours/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating Allocations from Scheduled Hours for Resources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will create allocations for workspace resources based on their scheduled hours."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is only usable for Account Administrators and users with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Users can edit allocations for unnamed resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Users can edit allocations for named resources"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Edit Allocations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Resource Management"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Access Group Set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Resource objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_resources~1{id}~1allocations_matching_scheduled_hours/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `custom_field_values` (CustomFieldValue) - Retrieves the custom field values for the resource. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `organization_membership` (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include `organization_membership_id`, which references the data in the `organization_memberships` top-level key.\n- `participation` (Participation) - Retrieves the participation associated with the resource. The response will include `participation_id`, which references the data in the `participations` top-level key.\n- `role` (Role) - Retrieves the role for this resource. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Retrieves the user associated with the resource. The response will include `user_id`, which references the data in the `users` top-level key. For unnamed resources, the `user_id` will be `null`.\n- `workspace` (Workspace) - Retrieves the workspace (project) the resource is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_499","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspace_resources~1{id}~1allocations_matching_scheduled_hours/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_502"}},"schemaId":"schema_502","pointer":"/paths/~1workspace_resources~1{id}~1allocations_matching_scheduled_hours/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workspace_resources/{id}/allocations_matching_scheduled_hours","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_499","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_502"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_resources/{id}/allocations_matching_scheduled_hours","href":"workspace-resources/create workspace resource allocations from scheduled hours by id","openApiOperationId":"Create Workspace Resource Allocations From Scheduled Hours By Id","summary":"Creating Allocations from Scheduled Hours for Resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_502","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_502"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Resource has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_503"}},"schemaId":"schema_503"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_resources~1{id}~1allocations_matching_scheduled_hours/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_503","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_503"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_resources/{id}/allocations_matching_scheduled_hours"}],"content":{"contentType":"group","meta":{"name":"Workspace Resources"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workspace Resources","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A workspace resource is the object that is tied to assignments and allocations within a Workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workspace Resources can be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Named Resources: Resources with a user_id."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unnamed Resources: Resources with no user_id."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With workspace resources it is possible for a user to have many resources with different roles"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"within a single workspace."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workspace resources can be assigned to tasks via Assignments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. In an example workspace, 'the Accounting Project', we could have 3 workspace resources:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alice as an Engineer in the Accounting Project"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alice as an Designer in the Accounting Project"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bob as a Designer in the Accounting Project"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With workspace resources, Alice could be assigned to one task as an Engineer and use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Engineer rate for that task, and another task be assigned as a Designer and thus the designer"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate would be used there."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a named workspace resource is created, if role_id is not specified, it will default to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the user's primary role within the project (see primary role definition below). When the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workspace resource is created, label with be generated based on the user's primary role."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workspace_resources","summary":"Fetching a list of Workspace Resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-resources/get workspace resources","deprecated":false},{"title":"/workspace_resources","summary":"Creating a new Workspace Resource","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workspace-resources/create workspace resource","deprecated":false},{"title":"/workspace_resources/allocations_matching_scheduled_hours","summary":"Creating Allocations from Scheduled Hours for Resources","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workspace-resources/create workspace resource allocations from scheduled hours","deprecated":false},{"title":"/workspace_resources/{id}","summary":"Fetching a single Workspace Resource","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-resources/get workspace resource","deprecated":false},{"title":"/workspace_resources/{id}","summary":"Updating an existing Workspace Resource","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspace-resources/update workspace resource","deprecated":false},{"title":"/workspace_resources/{id}","summary":"Deleting an existing Workspace Resource","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workspace-resources/delete workspace resource","deprecated":false},{"title":"/workspace_resources/{id}/allocations_matching_scheduled_hours","summary":"Creating Allocations from Scheduled Hours for Resources","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workspace-resources/create workspace resource allocations from scheduled hours by id","deprecated":false}]}]}]}]}},{"type":"group","label":"Workspace Status Changes","link":"/kantata/specification/workspace-status-changes","routeSlug":"/kantata/specification/workspace-status-changes","items":[{"label":"Fetching a list of Workspace Status Changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-status-changes/get workspace status changes","routeSlug":"/kantata/specification/workspace-status-changes/get workspace status changes","metadata":{"seo":{"title":"Fetching a list of Workspace Status Changes","description":"Returns all project status changes that are visible to the user for the passed project ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Status Changes","name":"Fetching a list of Workspace Status Changes","isWebhook":false,"pointer":"/paths/~1workspace_status_changes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Workspace Status Changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all project status changes that are visible to the user for the passed project ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Status Change objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_status_changes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Required parameter for retrieving status changes for a specified project.","required":true},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - References the user who made the change.\n- `workspace` (Workspace) - References the project for which the status changed."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1workspace_status_changes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_status_changes","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"workspace_id","in":"query","required":true,"schemaId":"schema_313"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_status_changes","href":"workspace-status-changes/get workspace status changes","openApiOperationId":"Get Workspace Status Changes","summary":"Fetching a list of Workspace Status Changes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Workspace Status Changes have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_505"}},"schemaId":"schema_505"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_status_changes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_505","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_505"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_status_changes"},{"label":"Creating a new Workspace Status Change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-status-changes/create workspace status change","routeSlug":"/kantata/specification/workspace-status-changes/create workspace status change","metadata":{"seo":{"title":"Creating a new Workspace Status Change","description":"This endpoint returns structured Workspace Status Change objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspace_status_changes top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workspace Status Change","name":"Creating a new Workspace Status Change","isWebhook":false,"pointer":"/paths/~1workspace_status_changes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Workspace Status Change","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Status Change objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_status_changes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - References the user who made the change.\n- `workspace` (Workspace) - References the project for which the status changed."}],"pointer":"/paths/~1workspace_status_changes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_506"}},"schemaId":"schema_506","pointer":"/paths/~1workspace_status_changes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workspace_status_changes","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_506"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_status_changes","href":"workspace-status-changes/create workspace status change","openApiOperationId":"Create Workspace Status Change","summary":"Creating a new Workspace Status Change"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_506","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_506"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Status Change has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_505"}},"schemaId":"schema_505"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_status_changes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_505","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_505"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_status_changes"},{"label":"Fetching a single Workspace Status Change","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-status-changes/get workspace status change","routeSlug":"/kantata/specification/workspace-status-changes/get workspace status change","metadata":{"seo":{"title":"Fetching a single Workspace Status Change","description":"Return the status change for the passed project status change ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace Status Change","name":"Fetching a single Workspace Status Change","isWebhook":false,"pointer":"/paths/~1workspace_status_changes~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Workspace Status Change","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return the status change for the passed project status change ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Status Change objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_status_changes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspace_status_changes~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - References the user who made the change.\n- `workspace` (Workspace) - References the project for which the status changed."}],"pointer":"/paths/~1workspace_status_changes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspace_status_changes/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_status_changes/{id}","href":"workspace-status-changes/get workspace status change","openApiOperationId":"Get Workspace Status Change","summary":"Fetching a single Workspace Status Change"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Workspace Status Change has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_505"}},"schemaId":"schema_505"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_status_changes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_505","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_505"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_status_changes/{id}"}],"content":{"contentType":"group","meta":{"name":"Workspace Status Changes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workspace Status Changes","showPageActions":true},{"nodeType":"markdoc","content":"Workspace Status Changes represent changes made to the status of a project."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workspace_status_changes","summary":"Fetching a list of Workspace Status Changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-status-changes/get workspace status changes","deprecated":false},{"title":"/workspace_status_changes","summary":"Creating a new Workspace Status Change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workspace-status-changes/create workspace status change","deprecated":false},{"title":"/workspace_status_changes/{id}","summary":"Fetching a single Workspace Status Change","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspace-status-changes/get workspace status change","deprecated":false}]}]}]}]}},{"type":"group","label":"Workspace Task Status Sets","link":"/kantata/specification/workspace-task-status-sets","routeSlug":"/kantata/specification/workspace-task-status-sets","items":[{"label":"Update task status set on multiple workspaces","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspace-task-status-sets/update workspace task status set","routeSlug":"/kantata/specification/workspace-task-status-sets/update workspace task status set","metadata":{"seo":{"title":"Update task status set on multiple workspaces","description":"Updates the task status set for multiple projects. You must have permission to select task status sets to use the endpoint. If any specified workspaces cannot be updated, the entire request will fail and an error message will be returned that specifies which ones could be updated and why."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workspace Task Status Set","name":"Update task status set on multiple workspaces","isWebhook":false,"pointer":"/paths/~1workspace_task_status_sets~1bulk_update/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update task status set on multiple workspaces","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the task status set for multiple projects. You must have permission to select task status sets to use the endpoint. If any specified workspaces cannot be updated, the entire request will fail and an error message will be returned that specifies which ones could be updated and why."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Task Status Sets objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_task_status_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_507"}},"schemaId":"schema_507","pointer":"/paths/~1workspace_task_status_sets~1bulk_update/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspace_task_status_sets/bulk_update","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_507"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspace_task_status_sets/bulk_update","href":"workspace-task-status-sets/update workspace task status set","openApiOperationId":"Update Workspace Task Status Set","summary":"Update task status set on multiple workspaces"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_507","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_507"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Task Status Sets has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_508"}},"schemaId":"schema_508"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspace_task_status_sets~1bulk_update/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_508","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_508"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspace_task_status_sets/bulk_update"}],"content":{"contentType":"group","meta":{"name":"Workspace Task Status Sets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workspace Task Status Sets","showPageActions":true},{"nodeType":"markdoc","content":"Workspace Task Status Sets represent the connection between workspaces (projects) and task (story) status sets, which enable the use of custom task statuses."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workspace_task_status_sets/bulk_update","summary":"Update task status set on multiple workspaces","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspace-task-status-sets/update workspace task status set","deprecated":false}]}]}]}]}},{"type":"group","label":"Workspaces","link":"/kantata/specification/workspaces","routeSlug":"/kantata/specification/workspaces","items":[{"label":"Fetching a list of Workspaces","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspaces/get workspaces","routeSlug":"/kantata/specification/workspaces/get workspaces","metadata":{"seo":{"title":"Fetching a list of Workspaces","description":"Gets a list of projects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspaces","name":"Fetching a list of Workspaces","isWebhook":false,"pointer":"/paths/~1workspaces/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Workspaces","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a list of projects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has its own rate limit. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/9698066628123"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"workspaces/get workspaces/request/archived-projects","deepLinkHash":"/workspaces/get workspaces#workspaces/get workspaces/request/archived-projects"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archived Projects"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, archived projects are not returned in the response. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_archived=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to retrieve archived projects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspaces"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account_color_ids","in":"query","schemaId":"schema_304","description":"Filter by color ID. Provide a comma-separated list of color IDs."},{"name":"archived","in":"query","schemaId":"schema_304","description":"Filter for only archived projects, or include or exclude archived projects from the results. Options are `only`, `exclude`, and `include`."},{"name":"budgeted","in":"query","schemaId":"schema_305","description":"Return only budgeted projects (`true`) or only non-budgeted projects (`false`)."},{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field choice value, represented as a string with the custom field ID, followed by a\ncolon, and then comma-separated custom field choice value IDs. The custom field choice value can also be\nthe word `blank`. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\n\nThe following formats are supported:\n\n- `custom_field_ID:choice_value_ID`\n- `custom_field_ID:choice_value_1_ID,choice_value_2_ID`\n- `custom_field_ID:blank`\n- `(custom_field_1_ID:choice_value_1_ID,choice_value_2_ID):(custom_field_2_ID:choice_value_3_ID)`."},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field currency value, represented as a string with the custom field ID, followed by a\ncolon, and then the currency value. Optionally, the currency [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473) can be supplied as well, separated\nfrom the currency value by another colon. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200.2:USD):(2:100)`."},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field date value, represented as a string with the custom field ID, followed by a\ncolon, the starting date, another colon, and then the ending date. You can provide both a starting date\nand ending date, or provide just one. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:2014-12-05:2014-12-25):(2:2014-12-05)`."},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field number value, represented as a string with the custom field ID, followed by a\ncolon, and then the number value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200):(2:101)`."},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field text value, represented as a string with the custom field ID, followed by a\ncolon, and then the text value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:something):(2:else)`\n- `(1:something):(1:else)` (multiple values for the same field, returns objects matching any value)\n- `1` (bare field ID with no value, returns all objects that have any value for that field)."},{"name":"can_create_line_items","in":"query","schemaId":"schema_305","description":"Return only projects where the authenticated user can create expenses or time entries (`true`) or only projects where the user can't (`false`)."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_at","in":"query","schemaId":"schema_304","description":"(Deprecated) Use the `created_before` and `created_after` filters instead.\n\nFilter for projects created between a specified date range. Format as `from_date;to_date`. Dates must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example, `2014-12-05;2014-12-25`."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"creator","in":"query","schemaId":"schema_304","description":"Filter for projects created by a specific user(s). Provide a comma-separated list of user IDs. For example, `10,20`."},{"name":"current_user_is_maven_participant","in":"query","schemaId":"schema_305","description":"Filter for projects where the authenticated user is on the provider team. When included in your request, this filter is always processed as `true`; the actual value you provide is ignored."},{"name":"custom_date_range","in":"query","schemaId":"schema_304","description":"Filter for projects with date custom field value(s) within a specified range. Format as `custom_field_id:from_date:to_date;custom_field_id:from_date:to_date`. Multiple custom fields can be delimited by semicolons. Dates must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example, `1:2014-12-05:2014-12-25;2:2015-12-05:2015-12-25`."},{"name":"custom_integer_ranges","in":"query","schemaId":"schema_304","description":"Filter for projects with number custom field value(s) within a specified range. Format as `custom_field_id:min:max;custom_field_id:min:max`. Multiple custom fields can be delimited by semicolons. For example, `42:20:10;43:50:100`."},{"name":"due_date_after","in":"query","schemaId":"schema_368","description":"Filter for projects that are due after the specified date. Can be used with `due_date_before` to filter by a date range. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"due_date_before","in":"query","schemaId":"schema_368","description":"Filter for projects that are due before the specified date. Can be used with `due_date_after` to filter by a date range. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"except","in":"query","schemaId":"schema_304","description":"Filter out specific projects from the results. Provide a comma-separated list of workspace IDs."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"financials_viewable_by_user","in":"query","schemaId":"schema_305","description":"Return only projects that the authenticated user can view, has financial access in, and is on the provider team. If `false`, no filtering is applied."},{"name":"for_approver","in":"query","schemaId":"schema_313","description":"Filter for projects where the user with the specified user ID can approve time."},{"name":"has_approvers","in":"query","schemaId":"schema_305","description":"Return only projects that have an approver (`true`) or only projects that don't (`false`)."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"has_maven_participant","in":"query","schemaId":"schema_313","description":"Filter for projects where the user with the specified user ID is on the provider team."},{"name":"has_participant","in":"query","schemaId":"schema_313","description":"Filter for projects where the user with the specified user ID is a participant."},{"name":"has_participation","in":"query","schemaId":"schema_305","description":"Filter for projects where the authenticated user is a participant."},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304","description":"Filter by the presence of a custom field value for the specified comma-separated custom field ID(s)."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_color` (AccountColor) - Retrieves the color of the workspace. The response will include `account_color_id`, which references the data in the `account_colors` top-level key.\n- `account_insights_mappings` (AccountInsightsMapping) - Retrieves the Insights dynamic dashboards in the workspace. The response will include `account_insights_mapping_ids`, which references the data in the `account_insights_mappings` top-level key.\n- `approver` (User) - Retrieves the first approver (as determined by user ID) on the workspace who is viewable to the current user. The response will include `approver_id`, which references the data in the `users` top-level key.\n- `approvers` (User) - Retrieves all time approvers on the workspace who are viewable to the current user. The response will include `approver_ids`, which references the data in the `users` top-level key.\n- `billing_milestones` (BillingMilestone) - Retrieves the billing milestones for the workspace. The response will include `billing_milestone_ids`, which references the data in the `billing_milestones` top-level key.\n- `creator` (User) - Retrieves the user who created the project. The response will include `creator_id`, which references the data in the `users` top-level key. If the creator has left the project, you can use `primary_counterpart` to get the provider-side team lead.\n- `current_status_report` (StatusReport) - Retrieves the most recent project status report from today. The response will include `current_status_report_id`, which references the data in the `status_reports` top-level key.\n- `current_user_participation` (Participation) - Retrieves the workspace participation of the current user. The response will include `current_user_participation_ids`, which references the data in the `participations` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves custom field values for the workspace. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `financial_viewers` (User) - Retrieves the users on the project who have financial access. The response will include `financial_viewer_ids`, which references the data in the `users` top-level key.\n- `next_uncompleted_milestone` (Story) - Retrieves the next project milestone that is not complete. The response will include `next_uncompleted_milestone_id`, which references the data in the `stories` top-level key.\n- `participants` (User) - Retrieves users that are participating in the project. The response will include `participant_ids`, which references the data in the `users` top-level key.\n- `participations` (Participation) - Retrieves the [participations](/tag/Participations) of each participant in the project. The response will include `participation_ids`, which references the data in the `participations` top-level key.\n- `possible_approvers` (User) - Retrieves the users that can be made time approvers on the workspace. The response will include `possible_approver_ids`, which references the data in the `users` top-level key.\n- `primary_counterpart` (User) - Retrieves the lead of the Clients team. The response will include `primary_counterpart_id`, which references the data in the `users` top-level key.\n- `primary_maven` (User) - Retrieves the lead of the Providers team. The response will include `primary_maven_id`, which references the data in the `users` top-level key.\n- `primary_workspace_group` (WorkspaceGroup) - Retrieves the primary group associated with the project. The response will include `primary_workspace_group_id`, which references the data in the `workspace_groups` top-level key.\n- `status_reports` (StatusReport) - Retrieves the status reports for the workspace. The response will include `status_report_ids`, which references the data in the `status_reports` top-level key.\n- `timesheet_submissions` (TimesheetSubmission) - Retrieves the list of all submitted timesheets which the user can approve on the project. The response will include `timesheet_submission_ids`, which references the data in the `timesheet_submissions` top-level key.\n- `workspace_groups` (WorkspaceGroup) - Retrieves groups associated with the project that is visible to the current user. The response will include `workspace_group_ids`, which references the data in the `workspace_groups` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources for the workspace. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves the named and unnamed resources for the workspace. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"include_archived","in":"query","schemaId":"schema_351","description":"Include (`true`) or exclude (`false`) archived projects from the results."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Filter for projects with a title that match the specified string. This filter is not case sensitive. This filter functions as a \"starts with\" filter for each word in project titles.\n\nAdditionally, the following common words (known as stop words) are ignored: `a`, `an`, `and`, `are`, `as`, `at`, `be`, `but`, `by`, `for`, `if`, `in`, `into`, `is`, `it`, `no`, `not`, `of`, `on`, `or`, `such`, `that`, `the`, `their`, `then`, `there`, `these`, `they`, `this`, `to`, `was`, `with`."},{"name":"milestone_weight_percentage_complete","in":"query","schemaId":"schema_304","description":"Filter for projects which have a milestone percent completion within the specified range. Provide two comma-separated numbers. For example, `15,30`."},{"name":"on_account_by_orgs","in":"query","schemaId":"schema_305","description":"Filter for projects that are on the authenticated user’s account and within the organization hierarchy the authenticated user is a part of. Requires the Report Viewer account permission or above."},{"name":"on_my_account","in":"query","schemaId":"schema_305","description":"Filter for projects that are on the same account as the authenticated user."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"only_joinable","in":"query","schemaId":"schema_305","description":"Filter for projects which the authenticated user can join and are within the organization hierarchy the user is a part of."},{"name":"only_participating_or_joinable","in":"query","schemaId":"schema_305","description":"Filter for projects which the authenticated user is participating in or can join."},{"name":"only_project_manager_in","in":"query","schemaId":"schema_305","description":"Filter for projects that are on the same account as the authenticated user, where the user is on the provider team, and where they have financial access or higher."},{"name":"optional_fields","in":"query","schemaId":"schema_509","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `amount_paid:asc`, `amount_paid:desc`, `color_name:asc`, `color_name:desc`, `created_at:asc`, `created_at:desc`, `custom_field::asc`, `custom_field::desc`, `due_date:asc`, `due_date:desc`, `last_viewed:asc`, `last_viewed:desc`, `percentage_complete:asc`, `percentage_complete:desc`, `price:asc`, `price:desc`, `provider_lead_name:asc`, `provider_lead_name:desc`, `search`, `start_date:asc`, `start_date:desc`, `status:asc`, `status:desc`, `task_status_set:asc`, `task_status_set:desc`, `title:asc`, `title:desc`, `updated_at:asc`, and `updated_at:desc`.\n\nNote: The `custom_field::asc` and `custom_field::desc` options do not support multi-choice custom fields."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"participant_or_org_member_in","in":"query","schemaId":"schema_305","description":"Filter for projects that are on the same account as the authenticated user, that the user is participating in, and that are within the organization hierarchy the user is a part of."},{"name":"pending_timesheet_submissions","in":"query","schemaId":"schema_304","description":"Filter for projects that have pending timesheet submissions within a specified date range. Format as `from_date;to_date`. Dates must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example, `2014-12-05;2014-12-25`."},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"provider_lead","in":"query","schemaId":"schema_304","description":"Filter for projects with the specified provider team leads. Provide a comma-separated list of user IDs. For example, `10,20`."},{"name":"require_time_approvals","in":"query","schemaId":"schema_305","description":"Return only projects that require time approvals (`true`) or only projects that don't (`false`)."},{"name":"requiring_expense_approval","in":"query","schemaId":"schema_305","description":"Return only projects that require expense approvals (`true`) or only projects that don't (`false`)."},{"name":"search","in":"query","schemaId":"schema_304","description":"The `search` parameter filters for projects that match one or more keywords. By default, the following fields are searched:\n - `workspace_id`\n - `title`\n - `description`\n - `full_name` of the `primary_maven` (i.e. the Provider team lead)\n - `full_name` of the `primary_counterpart` (i.e. the Client team lead)\n - `name` of `workspace_groups`, including the `primary_workspace_group`\n - `display_value` of `custom_field_values` (Excluding `currency` and `date` custom fields)\n\n You can search on specific fields using the format `search=field_name:'keyword'`. For example, `search=description:'acme'`. This is supported for the following fields:\n - `title`\n - `description`\n - `group` - Searches only the `name` field of `workspace_groups`. The keyword must match the entire name of the group (i.e. not a partial match).\n - `custom_field_value` - Searches the `display_value` of `custom_field_values`. (Excluding `currency` and `date` custom fields.)\n - `status` - Searches only the `message` field of the project `status`. The keyword must match the entire name of the project status (i.e. not a partial match).\n\n To combine multiple field-specific search terms, separate them by a space. For example, `search=title:'acme' description:'website'`.\n\n You can combine a field-specific search term with general search terms. For example, `search=description:'acme' design`."},{"name":"selected_choices","in":"query","schemaId":"schema_304","description":"Filter for projects that have a specific choice selected for a choice custom field. Format as `custom_field_id:choice_ids;custom_field_id:choice_ids`. Pass `none` to indicate no selection. Multiple custom fields can be delimited by semicolons. For example: `1:3,2;4:2,none`."},{"name":"stage","in":"query","schemaId":"schema_304","description":"Return only projects in the estimate stage or project stage. Options are `estimate` and `project`."},{"name":"start_date_after","in":"query","schemaId":"schema_368","description":"Filter for projects that start after the specified date. Can be used with `start_date_before` to filter by a date range. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"start_date_before","in":"query","schemaId":"schema_368","description":"Filter for projects that start before the specified date. Can be used with `start_date_after` to filter by a date range. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"user_not_participating","in":"query","schemaId":"schema_313","description":"Filter for projects where the user with the specified ID is not participating."},{"name":"viewable_for_time_administration","in":"query","schemaId":"schema_305","description":"Return only projects where the authenticated user can approve time. Can be used in combination with the `include_archived` filter."},{"name":"with_organizations","in":"query","schemaId":"schema_305","description":"Only includes projects that have an organization (true) or only includes projects that do not have an organization (false)."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_groups","in":"query","schemaId":"schema_304","description":"Filter for projects that are associated with the specified [project groups](https://developer.kantata.com/tag/Workspace-Groups). Provide a comma-separated list of group IDs. For example, `10,20`."}],"pointer":"/paths/~1workspaces/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspaces","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"account_color_ids","in":"query","schemaId":"schema_304"},{"name":"archived","in":"query","schemaId":"schema_304"},{"name":"budgeted","in":"query","schemaId":"schema_305"},{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304"},{"name":"can_create_line_items","in":"query","schemaId":"schema_305"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_at","in":"query","schemaId":"schema_304"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"creator","in":"query","schemaId":"schema_304"},{"name":"current_user_is_maven_participant","in":"query","schemaId":"schema_305"},{"name":"custom_date_range","in":"query","schemaId":"schema_304"},{"name":"custom_integer_ranges","in":"query","schemaId":"schema_304"},{"name":"due_date_after","in":"query","schemaId":"schema_368"},{"name":"due_date_before","in":"query","schemaId":"schema_368"},{"name":"except","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"financials_viewable_by_user","in":"query","schemaId":"schema_305"},{"name":"for_approver","in":"query","schemaId":"schema_313"},{"name":"has_approvers","in":"query","schemaId":"schema_305"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"has_maven_participant","in":"query","schemaId":"schema_313"},{"name":"has_participant","in":"query","schemaId":"schema_313"},{"name":"has_participation","in":"query","schemaId":"schema_305"},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"include_archived","in":"query","schemaId":"schema_351"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"milestone_weight_percentage_complete","in":"query","schemaId":"schema_304"},{"name":"on_account_by_orgs","in":"query","required":false,"schemaId":"schema_305"},{"name":"on_my_account","in":"query","schemaId":"schema_305"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"only_joinable","in":"query","required":false,"schemaId":"schema_305"},{"name":"only_participating_or_joinable","in":"query","required":false,"schemaId":"schema_305"},{"name":"only_project_manager_in","in":"query","required":false,"schemaId":"schema_305"},{"name":"optional_fields","in":"query","schemaId":"schema_509","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"participant_or_org_member_in","in":"query","required":false,"schemaId":"schema_305"},{"name":"pending_timesheet_submissions","in":"query","schemaId":"schema_304"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"provider_lead","in":"query","schemaId":"schema_304"},{"name":"require_time_approvals","in":"query","schemaId":"schema_305"},{"name":"requiring_expense_approval","in":"query","schemaId":"schema_305"},{"name":"search","in":"query","schemaId":"schema_304"},{"name":"selected_choices","in":"query","schemaId":"schema_304"},{"name":"stage","in":"query","schemaId":"schema_304"},{"name":"start_date_after","in":"query","schemaId":"schema_368"},{"name":"start_date_before","in":"query","schemaId":"schema_368"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"user_not_participating","in":"query","schemaId":"schema_313"},{"name":"viewable_for_time_administration","in":"query","schemaId":"schema_305"},{"name":"with_organizations","in":"query","schemaId":"schema_305"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_groups","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspaces","href":"workspaces/get workspaces","openApiOperationId":"Get Workspaces","summary":"Fetching a list of Workspaces"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Workspaces have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}},"schemaId":"schema_510"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspaces/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_510","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspaces"},{"label":"Creating a new Workspace","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspaces/create workspace","routeSlug":"/kantata/specification/workspaces/create workspace","metadata":{"seo":{"title":"Creating a new Workspace","description":"Creates a new workspace (project)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workspace","name":"Creating a new Workspace","isWebhook":false,"pointer":"/paths/~1workspaces/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Workspace","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new workspace (project)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has its own rate limit. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/9698066628123"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"workspaces\": [\n {\n \"title\": \"Acme Inc - Website Redesign\"\n },\n {\n \"title\": \"Acme Inc - Marketing Plan\"\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"workspaces\": [\n {\n \"title\": \"Acme Inc - Website Redesign\"\n },\n {\n \"title\": \"Acme Inc - Marketing Plan\"\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspaces"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_color` (AccountColor) - Retrieves the color of the workspace. The response will include `account_color_id`, which references the data in the `account_colors` top-level key.\n- `account_insights_mappings` (AccountInsightsMapping) - Retrieves the Insights dynamic dashboards in the workspace. The response will include `account_insights_mapping_ids`, which references the data in the `account_insights_mappings` top-level key.\n- `approver` (User) - Retrieves the first approver (as determined by user ID) on the workspace who is viewable to the current user. The response will include `approver_id`, which references the data in the `users` top-level key.\n- `approvers` (User) - Retrieves all time approvers on the workspace who are viewable to the current user. The response will include `approver_ids`, which references the data in the `users` top-level key.\n- `billing_milestones` (BillingMilestone) - Retrieves the billing milestones for the workspace. The response will include `billing_milestone_ids`, which references the data in the `billing_milestones` top-level key.\n- `creator` (User) - Retrieves the user who created the project. The response will include `creator_id`, which references the data in the `users` top-level key. If the creator has left the project, you can use `primary_counterpart` to get the provider-side team lead.\n- `current_status_report` (StatusReport) - Retrieves the most recent project status report from today. The response will include `current_status_report_id`, which references the data in the `status_reports` top-level key.\n- `current_user_participation` (Participation) - Retrieves the workspace participation of the current user. The response will include `current_user_participation_ids`, which references the data in the `participations` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves custom field values for the workspace. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `financial_viewers` (User) - Retrieves the users on the project who have financial access. The response will include `financial_viewer_ids`, which references the data in the `users` top-level key.\n- `next_uncompleted_milestone` (Story) - Retrieves the next project milestone that is not complete. The response will include `next_uncompleted_milestone_id`, which references the data in the `stories` top-level key.\n- `participants` (User) - Retrieves users that are participating in the project. The response will include `participant_ids`, which references the data in the `users` top-level key.\n- `participations` (Participation) - Retrieves the [participations](/tag/Participations) of each participant in the project. The response will include `participation_ids`, which references the data in the `participations` top-level key.\n- `possible_approvers` (User) - Retrieves the users that can be made time approvers on the workspace. The response will include `possible_approver_ids`, which references the data in the `users` top-level key.\n- `primary_counterpart` (User) - Retrieves the lead of the Clients team. The response will include `primary_counterpart_id`, which references the data in the `users` top-level key.\n- `primary_maven` (User) - Retrieves the lead of the Providers team. The response will include `primary_maven_id`, which references the data in the `users` top-level key.\n- `primary_workspace_group` (WorkspaceGroup) - Retrieves the primary group associated with the project. The response will include `primary_workspace_group_id`, which references the data in the `workspace_groups` top-level key.\n- `status_reports` (StatusReport) - Retrieves the status reports for the workspace. The response will include `status_report_ids`, which references the data in the `status_reports` top-level key.\n- `timesheet_submissions` (TimesheetSubmission) - Retrieves the list of all submitted timesheets which the user can approve on the project. The response will include `timesheet_submission_ids`, which references the data in the `timesheet_submissions` top-level key.\n- `workspace_groups` (WorkspaceGroup) - Retrieves groups associated with the project that is visible to the current user. The response will include `workspace_group_ids`, which references the data in the `workspace_groups` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources for the workspace. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves the named and unnamed resources for the workspace. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_509","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspaces/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_511"}},"schemaId":"schema_511","pointer":"/paths/~1workspaces/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workspaces","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_509","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_511"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspaces","href":"workspaces/create workspace","openApiOperationId":"Create Workspace","summary":"Creating a new Workspace"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_511","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_511"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}},"schemaId":"schema_510"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspaces/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_510","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspaces"},{"label":"Fetching a single Workspace","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspaces/get workspace","routeSlug":"/kantata/specification/workspaces/get workspace","metadata":{"seo":{"title":"Fetching a single Workspace","description":"Gets a project by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workspace","name":"Fetching a single Workspace","isWebhook":false,"pointer":"/paths/~1workspaces~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Workspace","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets a project by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, you will receive a 404 status if you try to retrieve an archived project. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_archived:true"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter to retrieve an archived project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users with Project Lead (or lower) account permissions can retrieve projects they are not participating in if they have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"All projects"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"All projects accessible to their organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (if Organizations are enabled) permission in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"View Resource Center"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Resource Management"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Access Group set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspaces"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspaces~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_color` (AccountColor) - Retrieves the color of the workspace. The response will include `account_color_id`, which references the data in the `account_colors` top-level key.\n- `account_insights_mappings` (AccountInsightsMapping) - Retrieves the Insights dynamic dashboards in the workspace. The response will include `account_insights_mapping_ids`, which references the data in the `account_insights_mappings` top-level key.\n- `approver` (User) - Retrieves the first approver (as determined by user ID) on the workspace who is viewable to the current user. The response will include `approver_id`, which references the data in the `users` top-level key.\n- `approvers` (User) - Retrieves all time approvers on the workspace who are viewable to the current user. The response will include `approver_ids`, which references the data in the `users` top-level key.\n- `billing_milestones` (BillingMilestone) - Retrieves the billing milestones for the workspace. The response will include `billing_milestone_ids`, which references the data in the `billing_milestones` top-level key.\n- `creator` (User) - Retrieves the user who created the project. The response will include `creator_id`, which references the data in the `users` top-level key. If the creator has left the project, you can use `primary_counterpart` to get the provider-side team lead.\n- `current_status_report` (StatusReport) - Retrieves the most recent project status report from today. The response will include `current_status_report_id`, which references the data in the `status_reports` top-level key.\n- `current_user_participation` (Participation) - Retrieves the workspace participation of the current user. The response will include `current_user_participation_ids`, which references the data in the `participations` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves custom field values for the workspace. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `financial_viewers` (User) - Retrieves the users on the project who have financial access. The response will include `financial_viewer_ids`, which references the data in the `users` top-level key.\n- `next_uncompleted_milestone` (Story) - Retrieves the next project milestone that is not complete. The response will include `next_uncompleted_milestone_id`, which references the data in the `stories` top-level key.\n- `participants` (User) - Retrieves users that are participating in the project. The response will include `participant_ids`, which references the data in the `users` top-level key.\n- `participations` (Participation) - Retrieves the [participations](/tag/Participations) of each participant in the project. The response will include `participation_ids`, which references the data in the `participations` top-level key.\n- `possible_approvers` (User) - Retrieves the users that can be made time approvers on the workspace. The response will include `possible_approver_ids`, which references the data in the `users` top-level key.\n- `primary_counterpart` (User) - Retrieves the lead of the Clients team. The response will include `primary_counterpart_id`, which references the data in the `users` top-level key.\n- `primary_maven` (User) - Retrieves the lead of the Providers team. The response will include `primary_maven_id`, which references the data in the `users` top-level key.\n- `primary_workspace_group` (WorkspaceGroup) - Retrieves the primary group associated with the project. The response will include `primary_workspace_group_id`, which references the data in the `workspace_groups` top-level key.\n- `status_reports` (StatusReport) - Retrieves the status reports for the workspace. The response will include `status_report_ids`, which references the data in the `status_reports` top-level key.\n- `timesheet_submissions` (TimesheetSubmission) - Retrieves the list of all submitted timesheets which the user can approve on the project. The response will include `timesheet_submission_ids`, which references the data in the `timesheet_submissions` top-level key.\n- `workspace_groups` (WorkspaceGroup) - Retrieves groups associated with the project that is visible to the current user. The response will include `workspace_group_ids`, which references the data in the `workspace_groups` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources for the workspace. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves the named and unnamed resources for the workspace. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_509","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspaces~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspaces/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_509","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspaces/{id}","href":"workspaces/get workspace","openApiOperationId":"Get Workspace","summary":"Fetching a single Workspace"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Workspace has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}},"schemaId":"schema_510"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspaces~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_510","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspaces/{id}"},{"label":"Updating an existing Workspace","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspaces/update workspace","routeSlug":"/kantata/specification/workspaces/update workspace","metadata":{"seo":{"title":"Updating an existing Workspace","description":"This endpoint returns structured Workspace objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workspaces top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workspace","name":"Updating an existing Workspace","isWebhook":false,"pointer":"/paths/~1workspaces~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Workspace","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspaces"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspaces~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_color` (AccountColor) - Retrieves the color of the workspace. The response will include `account_color_id`, which references the data in the `account_colors` top-level key.\n- `account_insights_mappings` (AccountInsightsMapping) - Retrieves the Insights dynamic dashboards in the workspace. The response will include `account_insights_mapping_ids`, which references the data in the `account_insights_mappings` top-level key.\n- `approver` (User) - Retrieves the first approver (as determined by user ID) on the workspace who is viewable to the current user. The response will include `approver_id`, which references the data in the `users` top-level key.\n- `approvers` (User) - Retrieves all time approvers on the workspace who are viewable to the current user. The response will include `approver_ids`, which references the data in the `users` top-level key.\n- `billing_milestones` (BillingMilestone) - Retrieves the billing milestones for the workspace. The response will include `billing_milestone_ids`, which references the data in the `billing_milestones` top-level key.\n- `creator` (User) - Retrieves the user who created the project. The response will include `creator_id`, which references the data in the `users` top-level key. If the creator has left the project, you can use `primary_counterpart` to get the provider-side team lead.\n- `current_status_report` (StatusReport) - Retrieves the most recent project status report from today. The response will include `current_status_report_id`, which references the data in the `status_reports` top-level key.\n- `current_user_participation` (Participation) - Retrieves the workspace participation of the current user. The response will include `current_user_participation_ids`, which references the data in the `participations` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves custom field values for the workspace. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `financial_viewers` (User) - Retrieves the users on the project who have financial access. The response will include `financial_viewer_ids`, which references the data in the `users` top-level key.\n- `next_uncompleted_milestone` (Story) - Retrieves the next project milestone that is not complete. The response will include `next_uncompleted_milestone_id`, which references the data in the `stories` top-level key.\n- `participants` (User) - Retrieves users that are participating in the project. The response will include `participant_ids`, which references the data in the `users` top-level key.\n- `participations` (Participation) - Retrieves the [participations](/tag/Participations) of each participant in the project. The response will include `participation_ids`, which references the data in the `participations` top-level key.\n- `possible_approvers` (User) - Retrieves the users that can be made time approvers on the workspace. The response will include `possible_approver_ids`, which references the data in the `users` top-level key.\n- `primary_counterpart` (User) - Retrieves the lead of the Clients team. The response will include `primary_counterpart_id`, which references the data in the `users` top-level key.\n- `primary_maven` (User) - Retrieves the lead of the Providers team. The response will include `primary_maven_id`, which references the data in the `users` top-level key.\n- `primary_workspace_group` (WorkspaceGroup) - Retrieves the primary group associated with the project. The response will include `primary_workspace_group_id`, which references the data in the `workspace_groups` top-level key.\n- `status_reports` (StatusReport) - Retrieves the status reports for the workspace. The response will include `status_report_ids`, which references the data in the `status_reports` top-level key.\n- `timesheet_submissions` (TimesheetSubmission) - Retrieves the list of all submitted timesheets which the user can approve on the project. The response will include `timesheet_submission_ids`, which references the data in the `timesheet_submissions` top-level key.\n- `workspace_groups` (WorkspaceGroup) - Retrieves groups associated with the project that is visible to the current user. The response will include `workspace_group_ids`, which references the data in the `workspace_groups` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources for the workspace. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves the named and unnamed resources for the workspace. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_509","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspaces~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_512"}},"schemaId":"schema_512","pointer":"/paths/~1workspaces~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspaces/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_509","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_512"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspaces/{id}","href":"workspaces/update workspace","openApiOperationId":"Update Workspace","summary":"Updating an existing Workspace"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_512","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_512"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}},"schemaId":"schema_510"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspaces~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_510","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspaces/{id}"},{"label":"Deleting an existing Workspace","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspaces/delete workspace","routeSlug":"/kantata/specification/workspaces/delete workspace","metadata":{"seo":{"title":"Deleting an existing Workspace","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Workspace","name":"Deleting an existing Workspace","isWebhook":false,"pointer":"/paths/~1workspaces~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Workspace","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspaces~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workspaces/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/workspaces/{id}","href":"workspaces/delete workspace","openApiOperationId":"Delete Workspace","summary":"Deleting an existing Workspace"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Workspace has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspaces~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspaces/{id}"},{"label":"Apply a Project Template to an existing Workspace","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspaces/apply project template to workspace","routeSlug":"/kantata/specification/workspaces/apply project template to workspace","metadata":{"seo":{"title":"Apply a Project Template to an existing Workspace","description":"Applies a template to an existing project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Apply Project Template To Workspace","name":"Apply a Project Template to an existing Workspace","isWebhook":false,"pointer":"/paths/~1workspaces~1{id}~1apply_template/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply a Project Template to an existing Workspace","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies a template to an existing project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspaces"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspaces~1{id}~1apply_template/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"edit_stories","in":"query","schemaId":"schema_305","description":"If `true`, the project participants and unnamed resources specified in the request body\nwill be added to the project, but the template tasks will not actually be created in the\nproject. Instead, `template_stories_json` will be returned in the response, containing\ninformation about the template tasks and assignments."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_color` (AccountColor) - Retrieves the color of the workspace. The response will include `account_color_id`, which references the data in the `account_colors` top-level key.\n- `account_insights_mappings` (AccountInsightsMapping) - Retrieves the Insights dynamic dashboards in the workspace. The response will include `account_insights_mapping_ids`, which references the data in the `account_insights_mappings` top-level key.\n- `approver` (User) - Retrieves the first approver (as determined by user ID) on the workspace who is viewable to the current user. The response will include `approver_id`, which references the data in the `users` top-level key.\n- `approvers` (User) - Retrieves all time approvers on the workspace who are viewable to the current user. The response will include `approver_ids`, which references the data in the `users` top-level key.\n- `billing_milestones` (BillingMilestone) - Retrieves the billing milestones for the workspace. The response will include `billing_milestone_ids`, which references the data in the `billing_milestones` top-level key.\n- `creator` (User) - Retrieves the user who created the project. The response will include `creator_id`, which references the data in the `users` top-level key. If the creator has left the project, you can use `primary_counterpart` to get the provider-side team lead.\n- `current_status_report` (StatusReport) - Retrieves the most recent project status report from today. The response will include `current_status_report_id`, which references the data in the `status_reports` top-level key.\n- `current_user_participation` (Participation) - Retrieves the workspace participation of the current user. The response will include `current_user_participation_ids`, which references the data in the `participations` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves custom field values for the workspace. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `financial_viewers` (User) - Retrieves the users on the project who have financial access. The response will include `financial_viewer_ids`, which references the data in the `users` top-level key.\n- `next_uncompleted_milestone` (Story) - Retrieves the next project milestone that is not complete. The response will include `next_uncompleted_milestone_id`, which references the data in the `stories` top-level key.\n- `participants` (User) - Retrieves users that are participating in the project. The response will include `participant_ids`, which references the data in the `users` top-level key.\n- `participations` (Participation) - Retrieves the [participations](/tag/Participations) of each participant in the project. The response will include `participation_ids`, which references the data in the `participations` top-level key.\n- `possible_approvers` (User) - Retrieves the users that can be made time approvers on the workspace. The response will include `possible_approver_ids`, which references the data in the `users` top-level key.\n- `primary_counterpart` (User) - Retrieves the lead of the Clients team. The response will include `primary_counterpart_id`, which references the data in the `users` top-level key.\n- `primary_maven` (User) - Retrieves the lead of the Providers team. The response will include `primary_maven_id`, which references the data in the `users` top-level key.\n- `primary_workspace_group` (WorkspaceGroup) - Retrieves the primary group associated with the project. The response will include `primary_workspace_group_id`, which references the data in the `workspace_groups` top-level key.\n- `status_reports` (StatusReport) - Retrieves the status reports for the workspace. The response will include `status_report_ids`, which references the data in the `status_reports` top-level key.\n- `timesheet_submissions` (TimesheetSubmission) - Retrieves the list of all submitted timesheets which the user can approve on the project. The response will include `timesheet_submission_ids`, which references the data in the `timesheet_submissions` top-level key.\n- `workspace_groups` (WorkspaceGroup) - Retrieves groups associated with the project that is visible to the current user. The response will include `workspace_group_ids`, which references the data in the `workspace_groups` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources for the workspace. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves the named and unnamed resources for the workspace. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_509","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspaces~1{id}~1apply_template/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_513"}},"schemaId":"schema_513","pointer":"/paths/~1workspaces~1{id}~1apply_template/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspaces/{id}/apply_template","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"edit_stories","in":"query","required":false,"schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_509","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_513"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspaces/{id}/apply_template","href":"workspaces/apply project template to workspace","openApiOperationId":"Apply Project Template To Workspace","summary":"Apply a Project Template to an existing Workspace"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_513","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_513"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}},"schemaId":"schema_510"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspaces~1{id}~1apply_template/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_510","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspaces/{id}/apply_template"},{"label":"Creating a Workspace Invitation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspaces/create workspace invitation","routeSlug":"/kantata/specification/workspaces/create workspace invitation","metadata":{"seo":{"title":"Creating a Workspace Invitation","description":"Sends an invitation to a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workspace Invitation","name":"Creating a Workspace Invitation","isWebhook":false,"pointer":"/paths/~1workspaces~1{id}~1invite/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a Workspace Invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends an invitation to a project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To add participants to a project, they must first be invited. Users that already exist in Kantata OX will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically accept the invitation and be added to the project. If your account allows anyone to be invited"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to projects, users that don't already exist will have the option to create an account. Otherwise, the invited"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user must be a member of your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has its own rate limit. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/9698066628123"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace Invitation objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_invitations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspaces~1{id}~1invite/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_514"}},"schemaId":"schema_514","pointer":"/paths/~1workspaces~1{id}~1invite/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workspaces/{id}/invite","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_514"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspaces/{id}/invite","href":"workspaces/create workspace invitation","openApiOperationId":"Create Workspace Invitation","summary":"Creating a Workspace Invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_514","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_514"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace Invitation has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}},"schemaId":"schema_515"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspaces~1{id}~1invite/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_515","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspaces/{id}/invite"},{"label":"Fetch permissions in a Workspace","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspaces/get my permissions in workspace","routeSlug":"/kantata/specification/workspaces/get my permissions in workspace","metadata":{"seo":{"title":"Fetch permissions in a Workspace","description":"Gets less common project permissions for the authenticated user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get My Permissions In Workspace","name":"Fetch permissions in a Workspace","isWebhook":false,"pointer":"/paths/~1workspaces~1{id}~1permissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch permissions in a Workspace","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets less common project permissions for the authenticated user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspaces"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspaces~1{id}~1permissions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_color` (AccountColor) - Retrieves the color of the workspace. The response will include `account_color_id`, which references the data in the `account_colors` top-level key.\n- `account_insights_mappings` (AccountInsightsMapping) - Retrieves the Insights dynamic dashboards in the workspace. The response will include `account_insights_mapping_ids`, which references the data in the `account_insights_mappings` top-level key.\n- `approver` (User) - Retrieves the first approver (as determined by user ID) on the workspace who is viewable to the current user. The response will include `approver_id`, which references the data in the `users` top-level key.\n- `approvers` (User) - Retrieves all time approvers on the workspace who are viewable to the current user. The response will include `approver_ids`, which references the data in the `users` top-level key.\n- `billing_milestones` (BillingMilestone) - Retrieves the billing milestones for the workspace. The response will include `billing_milestone_ids`, which references the data in the `billing_milestones` top-level key.\n- `creator` (User) - Retrieves the user who created the project. The response will include `creator_id`, which references the data in the `users` top-level key. If the creator has left the project, you can use `primary_counterpart` to get the provider-side team lead.\n- `current_status_report` (StatusReport) - Retrieves the most recent project status report from today. The response will include `current_status_report_id`, which references the data in the `status_reports` top-level key.\n- `current_user_participation` (Participation) - Retrieves the workspace participation of the current user. The response will include `current_user_participation_ids`, which references the data in the `participations` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves custom field values for the workspace. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `financial_viewers` (User) - Retrieves the users on the project who have financial access. The response will include `financial_viewer_ids`, which references the data in the `users` top-level key.\n- `next_uncompleted_milestone` (Story) - Retrieves the next project milestone that is not complete. The response will include `next_uncompleted_milestone_id`, which references the data in the `stories` top-level key.\n- `participants` (User) - Retrieves users that are participating in the project. The response will include `participant_ids`, which references the data in the `users` top-level key.\n- `participations` (Participation) - Retrieves the [participations](/tag/Participations) of each participant in the project. The response will include `participation_ids`, which references the data in the `participations` top-level key.\n- `possible_approvers` (User) - Retrieves the users that can be made time approvers on the workspace. The response will include `possible_approver_ids`, which references the data in the `users` top-level key.\n- `primary_counterpart` (User) - Retrieves the lead of the Clients team. The response will include `primary_counterpart_id`, which references the data in the `users` top-level key.\n- `primary_maven` (User) - Retrieves the lead of the Providers team. The response will include `primary_maven_id`, which references the data in the `users` top-level key.\n- `primary_workspace_group` (WorkspaceGroup) - Retrieves the primary group associated with the project. The response will include `primary_workspace_group_id`, which references the data in the `workspace_groups` top-level key.\n- `status_reports` (StatusReport) - Retrieves the status reports for the workspace. The response will include `status_report_ids`, which references the data in the `status_reports` top-level key.\n- `timesheet_submissions` (TimesheetSubmission) - Retrieves the list of all submitted timesheets which the user can approve on the project. The response will include `timesheet_submission_ids`, which references the data in the `timesheet_submissions` top-level key.\n- `workspace_groups` (WorkspaceGroup) - Retrieves groups associated with the project that is visible to the current user. The response will include `workspace_group_ids`, which references the data in the `workspace_groups` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources for the workspace. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves the named and unnamed resources for the workspace. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_509","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspaces~1{id}~1permissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workspaces/{id}/permissions","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_509","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspaces/{id}/permissions","href":"workspaces/get my permissions in workspace","openApiOperationId":"Get My Permissions In Workspace","summary":"Fetch permissions in a Workspace"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Workspaces have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_516"}},"schemaId":"schema_516"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspaces~1{id}~1permissions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_516","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_516"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspaces/{id}/permissions"},{"label":"Update expense approval setting","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspaces/update workspace expense approval setting","routeSlug":"/kantata/specification/workspaces/update workspace expense approval setting","metadata":{"seo":{"title":"Update expense approval setting","description":"Turns the expense approval setting for a project on or off."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workspace Expense Approval Setting","name":"Update expense approval setting","isWebhook":false,"pointer":"/paths/~1workspaces~1{id}~1toggle_expense_approvals/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update expense approval setting","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Turns the expense approval setting for a project on or off."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backfill_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, expenses until the specified date will be approved and the results of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"approval will be emailed to the authenticated user. Once the expenses have been approved, they cannot be unapproved."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspaces"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspaces~1{id}~1toggle_expense_approvals/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_color` (AccountColor) - Retrieves the color of the workspace. The response will include `account_color_id`, which references the data in the `account_colors` top-level key.\n- `account_insights_mappings` (AccountInsightsMapping) - Retrieves the Insights dynamic dashboards in the workspace. The response will include `account_insights_mapping_ids`, which references the data in the `account_insights_mappings` top-level key.\n- `approver` (User) - Retrieves the first approver (as determined by user ID) on the workspace who is viewable to the current user. The response will include `approver_id`, which references the data in the `users` top-level key.\n- `approvers` (User) - Retrieves all time approvers on the workspace who are viewable to the current user. The response will include `approver_ids`, which references the data in the `users` top-level key.\n- `billing_milestones` (BillingMilestone) - Retrieves the billing milestones for the workspace. The response will include `billing_milestone_ids`, which references the data in the `billing_milestones` top-level key.\n- `creator` (User) - Retrieves the user who created the project. The response will include `creator_id`, which references the data in the `users` top-level key. If the creator has left the project, you can use `primary_counterpart` to get the provider-side team lead.\n- `current_status_report` (StatusReport) - Retrieves the most recent project status report from today. The response will include `current_status_report_id`, which references the data in the `status_reports` top-level key.\n- `current_user_participation` (Participation) - Retrieves the workspace participation of the current user. The response will include `current_user_participation_ids`, which references the data in the `participations` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves custom field values for the workspace. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `financial_viewers` (User) - Retrieves the users on the project who have financial access. The response will include `financial_viewer_ids`, which references the data in the `users` top-level key.\n- `next_uncompleted_milestone` (Story) - Retrieves the next project milestone that is not complete. The response will include `next_uncompleted_milestone_id`, which references the data in the `stories` top-level key.\n- `participants` (User) - Retrieves users that are participating in the project. The response will include `participant_ids`, which references the data in the `users` top-level key.\n- `participations` (Participation) - Retrieves the [participations](/tag/Participations) of each participant in the project. The response will include `participation_ids`, which references the data in the `participations` top-level key.\n- `possible_approvers` (User) - Retrieves the users that can be made time approvers on the workspace. The response will include `possible_approver_ids`, which references the data in the `users` top-level key.\n- `primary_counterpart` (User) - Retrieves the lead of the Clients team. The response will include `primary_counterpart_id`, which references the data in the `users` top-level key.\n- `primary_maven` (User) - Retrieves the lead of the Providers team. The response will include `primary_maven_id`, which references the data in the `users` top-level key.\n- `primary_workspace_group` (WorkspaceGroup) - Retrieves the primary group associated with the project. The response will include `primary_workspace_group_id`, which references the data in the `workspace_groups` top-level key.\n- `status_reports` (StatusReport) - Retrieves the status reports for the workspace. The response will include `status_report_ids`, which references the data in the `status_reports` top-level key.\n- `timesheet_submissions` (TimesheetSubmission) - Retrieves the list of all submitted timesheets which the user can approve on the project. The response will include `timesheet_submission_ids`, which references the data in the `timesheet_submissions` top-level key.\n- `workspace_groups` (WorkspaceGroup) - Retrieves groups associated with the project that is visible to the current user. The response will include `workspace_group_ids`, which references the data in the `workspace_groups` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources for the workspace. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves the named and unnamed resources for the workspace. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_509","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspaces~1{id}~1toggle_expense_approvals/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_517"}},"schemaId":"schema_517","pointer":"/paths/~1workspaces~1{id}~1toggle_expense_approvals/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspaces/{id}/toggle_expense_approvals","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_509","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_517"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspaces/{id}/toggle_expense_approvals","href":"workspaces/update workspace expense approval setting","openApiOperationId":"Update Workspace Expense Approval Setting","summary":"Update expense approval setting"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_517","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_517"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}},"schemaId":"schema_510"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspaces~1{id}~1toggle_expense_approvals/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_510","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspaces/{id}/toggle_expense_approvals"},{"label":"Update time approval setting","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspaces/update workspace time approval setting","routeSlug":"/kantata/specification/workspaces/update workspace time approval setting","metadata":{"seo":{"title":"Update time approval setting","description":"Turns the time approval setting for a project on or off."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workspace Time Approval Setting","name":"Update time approval setting","isWebhook":false,"pointer":"/paths/~1workspaces~1{id}~1toggle_time_approvals/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update time approval setting","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Turns the time approval setting for a project on or off."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you enable the time approval setting and specify a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backfill_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", time entries until the specified date will be approved and the results of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"approval will be emailed to the authenticated user. Once the time entries have been approved, they cannot be unapproved."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This setting can't be turned off if there are active timesheet submissions or approvals for the project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspaces"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspaces~1{id}~1toggle_time_approvals/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_color` (AccountColor) - Retrieves the color of the workspace. The response will include `account_color_id`, which references the data in the `account_colors` top-level key.\n- `account_insights_mappings` (AccountInsightsMapping) - Retrieves the Insights dynamic dashboards in the workspace. The response will include `account_insights_mapping_ids`, which references the data in the `account_insights_mappings` top-level key.\n- `approver` (User) - Retrieves the first approver (as determined by user ID) on the workspace who is viewable to the current user. The response will include `approver_id`, which references the data in the `users` top-level key.\n- `approvers` (User) - Retrieves all time approvers on the workspace who are viewable to the current user. The response will include `approver_ids`, which references the data in the `users` top-level key.\n- `billing_milestones` (BillingMilestone) - Retrieves the billing milestones for the workspace. The response will include `billing_milestone_ids`, which references the data in the `billing_milestones` top-level key.\n- `creator` (User) - Retrieves the user who created the project. The response will include `creator_id`, which references the data in the `users` top-level key. If the creator has left the project, you can use `primary_counterpart` to get the provider-side team lead.\n- `current_status_report` (StatusReport) - Retrieves the most recent project status report from today. The response will include `current_status_report_id`, which references the data in the `status_reports` top-level key.\n- `current_user_participation` (Participation) - Retrieves the workspace participation of the current user. The response will include `current_user_participation_ids`, which references the data in the `participations` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves custom field values for the workspace. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `financial_viewers` (User) - Retrieves the users on the project who have financial access. The response will include `financial_viewer_ids`, which references the data in the `users` top-level key.\n- `next_uncompleted_milestone` (Story) - Retrieves the next project milestone that is not complete. The response will include `next_uncompleted_milestone_id`, which references the data in the `stories` top-level key.\n- `participants` (User) - Retrieves users that are participating in the project. The response will include `participant_ids`, which references the data in the `users` top-level key.\n- `participations` (Participation) - Retrieves the [participations](/tag/Participations) of each participant in the project. The response will include `participation_ids`, which references the data in the `participations` top-level key.\n- `possible_approvers` (User) - Retrieves the users that can be made time approvers on the workspace. The response will include `possible_approver_ids`, which references the data in the `users` top-level key.\n- `primary_counterpart` (User) - Retrieves the lead of the Clients team. The response will include `primary_counterpart_id`, which references the data in the `users` top-level key.\n- `primary_maven` (User) - Retrieves the lead of the Providers team. The response will include `primary_maven_id`, which references the data in the `users` top-level key.\n- `primary_workspace_group` (WorkspaceGroup) - Retrieves the primary group associated with the project. The response will include `primary_workspace_group_id`, which references the data in the `workspace_groups` top-level key.\n- `status_reports` (StatusReport) - Retrieves the status reports for the workspace. The response will include `status_report_ids`, which references the data in the `status_reports` top-level key.\n- `timesheet_submissions` (TimesheetSubmission) - Retrieves the list of all submitted timesheets which the user can approve on the project. The response will include `timesheet_submission_ids`, which references the data in the `timesheet_submissions` top-level key.\n- `workspace_groups` (WorkspaceGroup) - Retrieves groups associated with the project that is visible to the current user. The response will include `workspace_group_ids`, which references the data in the `workspace_groups` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources for the workspace. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves the named and unnamed resources for the workspace. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_509","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspaces~1{id}~1toggle_time_approvals/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","pointer":"/paths/~1workspaces~1{id}~1toggle_time_approvals/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspaces/{id}/toggle_time_approvals","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_509","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_518"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspaces/{id}/toggle_time_approvals","href":"workspaces/update workspace time approval setting","openApiOperationId":"Update Workspace Time Approval Setting","summary":"Update time approval setting"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_518"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}},"schemaId":"schema_510"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspaces~1{id}~1toggle_time_approvals/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_510","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspaces/{id}/toggle_time_approvals"},{"label":"Unarchive Workspace with Approvals","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workspaces/unarchive workspace with approvals","routeSlug":"/kantata/specification/workspaces/unarchive workspace with approvals","metadata":{"seo":{"title":"Unarchive Workspace with Approvals","description":"Unarchives a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Unarchive Workspace With Approvals","name":"Unarchive Workspace with Approvals","isWebhook":false,"pointer":"/paths/~1workspaces~1{id}~1unarchive_with_approvals/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unarchive Workspace with Approvals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unarchives a project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a time lock is set for the account and the project’s time approval setting is enabled, this endpoint will also"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"approve all unsubmitted time entries on or before the time lock date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workspace objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspaces"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workspaces~1{id}~1unarchive_with_approvals/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `account_color` (AccountColor) - Retrieves the color of the workspace. The response will include `account_color_id`, which references the data in the `account_colors` top-level key.\n- `account_insights_mappings` (AccountInsightsMapping) - Retrieves the Insights dynamic dashboards in the workspace. The response will include `account_insights_mapping_ids`, which references the data in the `account_insights_mappings` top-level key.\n- `approver` (User) - Retrieves the first approver (as determined by user ID) on the workspace who is viewable to the current user. The response will include `approver_id`, which references the data in the `users` top-level key.\n- `approvers` (User) - Retrieves all time approvers on the workspace who are viewable to the current user. The response will include `approver_ids`, which references the data in the `users` top-level key.\n- `billing_milestones` (BillingMilestone) - Retrieves the billing milestones for the workspace. The response will include `billing_milestone_ids`, which references the data in the `billing_milestones` top-level key.\n- `creator` (User) - Retrieves the user who created the project. The response will include `creator_id`, which references the data in the `users` top-level key. If the creator has left the project, you can use `primary_counterpart` to get the provider-side team lead.\n- `current_status_report` (StatusReport) - Retrieves the most recent project status report from today. The response will include `current_status_report_id`, which references the data in the `status_reports` top-level key.\n- `current_user_participation` (Participation) - Retrieves the workspace participation of the current user. The response will include `current_user_participation_ids`, which references the data in the `participations` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves custom field values for the workspace. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `financial_viewers` (User) - Retrieves the users on the project who have financial access. The response will include `financial_viewer_ids`, which references the data in the `users` top-level key.\n- `next_uncompleted_milestone` (Story) - Retrieves the next project milestone that is not complete. The response will include `next_uncompleted_milestone_id`, which references the data in the `stories` top-level key.\n- `participants` (User) - Retrieves users that are participating in the project. The response will include `participant_ids`, which references the data in the `users` top-level key.\n- `participations` (Participation) - Retrieves the [participations](/tag/Participations) of each participant in the project. The response will include `participation_ids`, which references the data in the `participations` top-level key.\n- `possible_approvers` (User) - Retrieves the users that can be made time approvers on the workspace. The response will include `possible_approver_ids`, which references the data in the `users` top-level key.\n- `primary_counterpart` (User) - Retrieves the lead of the Clients team. The response will include `primary_counterpart_id`, which references the data in the `users` top-level key.\n- `primary_maven` (User) - Retrieves the lead of the Providers team. The response will include `primary_maven_id`, which references the data in the `users` top-level key.\n- `primary_workspace_group` (WorkspaceGroup) - Retrieves the primary group associated with the project. The response will include `primary_workspace_group_id`, which references the data in the `workspace_groups` top-level key.\n- `status_reports` (StatusReport) - Retrieves the status reports for the workspace. The response will include `status_report_ids`, which references the data in the `status_reports` top-level key.\n- `timesheet_submissions` (TimesheetSubmission) - Retrieves the list of all submitted timesheets which the user can approve on the project. The response will include `timesheet_submission_ids`, which references the data in the `timesheet_submissions` top-level key.\n- `workspace_groups` (WorkspaceGroup) - Retrieves groups associated with the project that is visible to the current user. The response will include `workspace_group_ids`, which references the data in the `workspace_groups` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources for the workspace. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves the named and unnamed resources for the workspace. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_509","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1workspaces~1{id}~1unarchive_with_approvals/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workspaces/{id}/unarchive_with_approvals","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_509","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workspaces/{id}/unarchive_with_approvals","href":"workspaces/unarchive workspace with approvals","openApiOperationId":"Unarchive Workspace With Approvals","summary":"Unarchive Workspace with Approvals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}},"schemaId":"schema_510"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workspaces~1{id}~1unarchive_with_approvals/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_510","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workspaces/{id}/unarchive_with_approvals"}],"content":{"contentType":"group","meta":{"name":"Workspaces"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workspaces","showPageActions":true},{"nodeType":"markdoc","content":"Workspaces (also called projects) represent the space in which Kantata OX users plan, communicate, and collaborate."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workspaces","summary":"Fetching a list of Workspaces","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspaces/get workspaces","deprecated":false},{"title":"/workspaces","summary":"Creating a new Workspace","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workspaces/create workspace","deprecated":false},{"title":"/workspaces/{id}","summary":"Fetching a single Workspace","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspaces/get workspace","deprecated":false},{"title":"/workspaces/{id}","summary":"Updating an existing Workspace","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspaces/update workspace","deprecated":false},{"title":"/workspaces/{id}","summary":"Deleting an existing Workspace","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workspaces/delete workspace","deprecated":false},{"title":"/workspaces/{id}/apply_template","summary":"Apply a Project Template to an existing Workspace","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspaces/apply project template to workspace","deprecated":false},{"title":"/workspaces/{id}/invite","summary":"Creating a Workspace Invitation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workspaces/create workspace invitation","deprecated":false},{"title":"/workspaces/{id}/permissions","summary":"Fetch permissions in a Workspace","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspaces/get my permissions in workspace","deprecated":false},{"title":"/workspaces/{id}/toggle_expense_approvals","summary":"Update expense approval setting","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspaces/update workspace expense approval setting","deprecated":false},{"title":"/workspaces/{id}/toggle_time_approvals","summary":"Update time approval setting","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspaces/update workspace time approval setting","deprecated":false},{"title":"/workspaces/{id}/unarchive_with_approvals","summary":"Unarchive Workspace with Approvals","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspaces/unarchive workspace with approvals","deprecated":false}]}]}]}]}},{"type":"separator","label":"Rate Cards","content":null},{"type":"group","label":"Activations","link":"/kantata/specification/activations","routeSlug":"/kantata/specification/activations","items":[{"label":"Check Rate Cards Activation Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/activations/get activation status rate cards","routeSlug":"/kantata/specification/activations/get activation status rate cards","metadata":{"seo":{"title":"Check Rate Cards Activation Status","description":"This endpoint allows you to check whether the Rate Cards feature has been activated on the user's account. This endpoint is only accessible to users with Financial access (Project Lead or higher) on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Activation Status Rate Cards","name":"Check Rate Cards Activation Status","isWebhook":false,"pointer":"/paths/~1account_rate_cards_activations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check Rate Cards Activation Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to check whether the Rate Cards feature has been activated on\nthe user's account.\n This endpoint is only accessible to users with Financial access (Project Lead or higher) on the account."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_rate_cards_activations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_rate_cards_activations","href":"activations/get activation status rate cards","openApiOperationId":"Get Activation Status Rate Cards","summary":"Check Rate Cards Activation Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Activations have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_519"}},"schemaId":"schema_519"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_rate_cards_activations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_519","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_519"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_rate_cards_activations"},{"label":"Activate Rate Cards","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/activations/activate rate cards","routeSlug":"/kantata/specification/activations/activate rate cards","metadata":{"seo":{"title":"Activate Rate Cards","description":"Activate Rate Cards on a user's account by submitting a rate card set version that belongs to the default Rate Card Set. Only an Account Administrator can activate rate cards on an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Activate Rate Cards","name":"Activate Rate Cards","isWebhook":false,"pointer":"/paths/~1account_rate_cards_activations/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate Rate Cards","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Activate Rate Cards on a user's account by submitting a rate card set version that belongs to\nthe default Rate Card Set. Only an Account Administrator can activate rate cards on an account.\n\nThe initial request to this endpoint will generate an account default Rate Card Set and create a\nRate Card Set Version. This account default Rate Card Set will include a separate Rate Card for every currency\nused in projects on the user's account."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rate_card_set_version_id","in":"query","schemaId":"schema_313","description":"The ID of the Rate Card Set Version belonging to the account default Rate Card Set.","required":true}],"pointer":"/paths/~1account_rate_cards_activations/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/account_rate_cards_activations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"rate_card_set_version_id","in":"query","required":true,"schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/account_rate_cards_activations","href":"activations/activate rate cards","openApiOperationId":"Activate Rate Cards","summary":"Activate Rate Cards"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Activation has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_519"}},"schemaId":"schema_519"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1account_rate_cards_activations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_519","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_519"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/account_rate_cards_activations"}],"content":{"contentType":"group","meta":{"name":"Activations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activations","showPageActions":true},{"nodeType":"markdoc","content":"The Rate Card activation endpoints allow you to check whether the Rate Cards feature has been activated on\nthe user's account. It also allows you to activate the feature on the user's account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_rate_cards_activations","summary":"Check Rate Cards Activation Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activations/get activation status rate cards","deprecated":false},{"title":"/account_rate_cards_activations","summary":"Activate Rate Cards","prefix":{"name":"post","color":"post"},"badges":[],"link":"/activations/activate rate cards","deprecated":false}]}]}]}]}},{"type":"group","label":"Rate Card Role (Rate for a Role)","link":"/kantata/specification/rate-card-role-(rate-for-a-role)","routeSlug":"/kantata/specification/rate-card-role-(rate-for-a-role)","items":[{"label":"Fetching a list of Rate Card Roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-role-(rate-for-a-role)/get rate card roles","routeSlug":"/kantata/specification/rate-card-role-(rate-for-a-role)/get rate card roles","metadata":{"seo":{"title":"Fetching a list of Rate Card Roles","description":"Returns the Rate Card Roles associated with all Rate Card Versions on Rate Cards that belong to the logged-in user's account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Rate Card Roles","name":"Fetching a list of Rate Card Roles","isWebhook":false,"pointer":"/paths/~1rate_card_roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Rate Card Roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the Rate Card Roles associated with all Rate Card Versions on Rate Cards that belong to the logged-in user's account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Card Roles can only be accessed by an Administrator on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Role objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_version` (RateCardVersion) - The Rate Card Version to which this Rate Card Role belongs.\n- `role` (Role) - The account Role that this Rate Card Role represents."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_335","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"rate_card_version_id","in":"query","schemaId":"schema_313","description":"Restricts Rate Card Roles to the specified Rate Card Version."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"with_role_ids","in":"query","schemaId":"schema_352","description":"Restricts Rate Card Roles to the specified role ids."}],"pointer":"/paths/~1rate_card_roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rate_card_roles","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_335"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"rate_card_version_id","in":"query","schemaId":"schema_313"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"with_role_ids","in":"query","schemaId":"schema_352","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_roles","href":"rate-card-role-(rate-for-a-role)/get rate card roles","openApiOperationId":"Get Rate Card Roles","summary":"Fetching a list of Rate Card Roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Rate Card Roles have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}},"schemaId":"schema_520"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_520","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_roles"},{"label":"Creating a new Rate Card Role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-role-(rate-for-a-role)/create rate card role","routeSlug":"/kantata/specification/rate-card-role-(rate-for-a-role)/create rate card role","metadata":{"seo":{"title":"Creating a new Rate Card Role","description":"A Rate Card Role can only be created by an Administrator on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Rate Card Role","name":"Creating a new Rate Card Role","isWebhook":false,"pointer":"/paths/~1rate_card_roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Rate Card Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Rate Card Role can only be created by an Administrator on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Role objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_version` (RateCardVersion) - The Rate Card Version to which this Rate Card Role belongs.\n- `role` (Role) - The account Role that this Rate Card Role represents."}],"pointer":"/paths/~1rate_card_roles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1rate_card_roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rate_card_roles","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_roles","href":"rate-card-role-(rate-for-a-role)/create rate card role","openApiOperationId":"Create Rate Card Role","summary":"Creating a new Rate Card Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate Card Role has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}},"schemaId":"schema_520"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_roles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_520","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_roles"},{"label":"Fetching a single Rate Card Role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-role-(rate-for-a-role)/get rate card role","routeSlug":"/kantata/specification/rate-card-role-(rate-for-a-role)/get rate card role","metadata":{"seo":{"title":"Fetching a single Rate Card Role","description":"A Rate Card Role can only be accessed by an Administrator on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Rate Card Role","name":"Fetching a single Rate Card Role","isWebhook":false,"pointer":"/paths/~1rate_card_roles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Rate Card Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Rate Card Role can only be accessed by an Administrator on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Role objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_card_roles~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_version` (RateCardVersion) - The Rate Card Version to which this Rate Card Role belongs.\n- `role` (Role) - The account Role that this Rate Card Role represents."}],"pointer":"/paths/~1rate_card_roles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rate_card_roles/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_roles/{id}","href":"rate-card-role-(rate-for-a-role)/get rate card role","openApiOperationId":"Get Rate Card Role","summary":"Fetching a single Rate Card Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Rate Card Role has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}},"schemaId":"schema_520"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_roles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_520","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_roles/{id}"},{"label":"Updating an existing Rate Card Role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-role-(rate-for-a-role)/update rate card role","routeSlug":"/kantata/specification/rate-card-role-(rate-for-a-role)/update rate card role","metadata":{"seo":{"title":"Updating an existing Rate Card Role","description":"A Rate Card Role can only be modified by an Administrator on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Rate Card Role","name":"Updating an existing Rate Card Role","isWebhook":false,"pointer":"/paths/~1rate_card_roles~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Rate Card Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Rate Card Role can only be modified by an Administrator on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Role objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_card_roles~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_version` (RateCardVersion) - The Rate Card Version to which this Rate Card Role belongs.\n- `role` (Role) - The account Role that this Rate Card Role represents."}],"pointer":"/paths/~1rate_card_roles~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_522"}},"schemaId":"schema_522","pointer":"/paths/~1rate_card_roles~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rate_card_roles/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_522"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_roles/{id}","href":"rate-card-role-(rate-for-a-role)/update rate card role","openApiOperationId":"Update Rate Card Role","summary":"Updating an existing Rate Card Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_522","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_522"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate Card Role has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}},"schemaId":"schema_520"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_roles~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_520","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_roles/{id}"},{"label":"Deleting an existing Rate Card Role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-role-(rate-for-a-role)/delete rate card role","routeSlug":"/kantata/specification/rate-card-role-(rate-for-a-role)/delete rate card role","metadata":{"seo":{"title":"Deleting an existing Rate Card Role","description":"If a A Rate Card Role belongs to a Rate Card Version that is in use, it cannot be deleted. A Rate Card Role canonly be deleted by an Administrator on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Rate Card Role","name":"Deleting an existing Rate Card Role","isWebhook":false,"pointer":"/paths/~1rate_card_roles~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Rate Card Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a A Rate Card Role belongs to a Rate Card Version that is in use, it cannot be deleted. A Rate Card Role can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only be deleted by an Administrator on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_card_roles~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rate_card_roles/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/rate_card_roles/{id}","href":"rate-card-role-(rate-for-a-role)/delete rate card role","openApiOperationId":"Delete Rate Card Role","summary":"Deleting an existing Rate Card Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Rate Card Role has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_roles~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_roles/{id}"}],"content":{"contentType":"group","meta":{"name":"Rate Card Role (Rate for a Role)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rate Card Role (Rate for a Role)","showPageActions":true},{"nodeType":"markdoc","content":"Rate Card Roles belong to a Rate Card Version and represent the bill rate, in cents per hour, for a specific Role.\nFor example, the rate for the role of Developer may be 2000 cents per hour. It is not necessary, however, to create a Rate Card Role for\nevery role on your account if the rate is the same as the default rate on the Rate Card Version. When an\nexplicit Rate Card Role does not exist for a role on the account, the default rate on the Rate Card Version\nis used to calculate the total bill rate.\n\nRate Card Roles can only be accessed, edited, or deleted by an Administrator on the account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rate_card_roles","summary":"Fetching a list of Rate Card Roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-card-role-(rate-for-a-role)/get rate card roles","deprecated":false},{"title":"/rate_card_roles","summary":"Creating a new Rate Card Role","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rate-card-role-(rate-for-a-role)/create rate card role","deprecated":false},{"title":"/rate_card_roles/{id}","summary":"Fetching a single Rate Card Role","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-card-role-(rate-for-a-role)/get rate card role","deprecated":false},{"title":"/rate_card_roles/{id}","summary":"Updating an existing Rate Card Role","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rate-card-role-(rate-for-a-role)/update rate card role","deprecated":false},{"title":"/rate_card_roles/{id}","summary":"Deleting an existing Rate Card Role","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rate-card-role-(rate-for-a-role)/delete rate card role","deprecated":false}]}]}]}]}},{"type":"group","label":"Rate Card Set Version (Effective version by Date)","link":"/kantata/specification/rate-card-set-version-(effective-version-by-date)","routeSlug":"/kantata/specification/rate-card-set-version-(effective-version-by-date)","items":[{"label":"Fetching a list of Rate Card Set Versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-set-version-(effective-version-by-date)/get rate card set versions","routeSlug":"/kantata/specification/rate-card-set-version-(effective-version-by-date)/get rate card set versions","metadata":{"seo":{"title":"Fetching a list of Rate Card Set Versions","description":"Rate Card Set Versions are only accessible to Administrators on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Rate Card Set Versions","name":"Fetching a list of Rate Card Set Versions","isWebhook":false,"pointer":"/paths/~1rate_card_set_versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Rate Card Set Versions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Card Set Versions are only accessible to Administrators on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Set Version objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_set_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"effective_on_date","in":"query","schemaId":"schema_368","description":"Returns Rate Card Set Versions that are effective on the requested date.\nThe date should be in `` eg. `'2014-02-25'`. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_set` (RateCardSet) - The Rate Card Set this version belongs to.\n- `rate_card_versions` (RateCardVersion) - The Rate Card Version of each Rate Card defined on the Rate Card Set."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_335","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"rate_card_set_id","in":"query","schemaId":"schema_313","description":"Restricts Rate Card Set Versions to the specified Rate Card Set."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1rate_card_set_versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rate_card_set_versions","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"effective_on_date","in":"query","schemaId":"schema_368"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_335"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"rate_card_set_id","in":"query","schemaId":"schema_313"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_set_versions","href":"rate-card-set-version-(effective-version-by-date)/get rate card set versions","openApiOperationId":"Get Rate Card Set Versions","summary":"Fetching a list of Rate Card Set Versions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Rate Card Set Versions have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}},"schemaId":"schema_523"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_set_versions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_523","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_set_versions"},{"label":"Creating a new Rate Card Set Version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-set-version-(effective-version-by-date)/create rate card set version","routeSlug":"/kantata/specification/rate-card-set-version-(effective-version-by-date)/create rate card set version","metadata":{"seo":{"title":"Creating a new Rate Card Set Version","description":"Rate Card Set Versions can only created by an Administrator on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Rate Card Set Version","name":"Creating a new Rate Card Set Version","isWebhook":false,"pointer":"/paths/~1rate_card_set_versions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Rate Card Set Version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Card Set Versions can only created by an Administrator on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating/Cloning a Rate Card Set Version on a Rate Card Set, does the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates/Clones a Rate Card Version for each existing Rate Card on the associated Rate Card Set."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates/Clones necessary associations for each Rate Card Version."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Set Version objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_set_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clone_id","in":"query","schemaId":"schema_313","description":"The ID of the Rate Card Set Version to be cloned."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_set` (RateCardSet) - The Rate Card Set this version belongs to.\n- `rate_card_versions` (RateCardVersion) - The Rate Card Version of each Rate Card defined on the Rate Card Set."}],"pointer":"/paths/~1rate_card_set_versions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_524"}},"schemaId":"schema_524","pointer":"/paths/~1rate_card_set_versions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rate_card_set_versions","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"clone_id","in":"query","required":false,"schemaId":"schema_313"},{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_524"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_set_versions","href":"rate-card-set-version-(effective-version-by-date)/create rate card set version","openApiOperationId":"Create Rate Card Set Version","summary":"Creating a new Rate Card Set Version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_524","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_524"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate Card Set Version has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}},"schemaId":"schema_523"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_set_versions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_523","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_set_versions"},{"label":"Fetching a single Rate Card Set Version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-set-version-(effective-version-by-date)/get rate card set version","routeSlug":"/kantata/specification/rate-card-set-version-(effective-version-by-date)/get rate card set version","metadata":{"seo":{"title":"Fetching a single Rate Card Set Version","description":"A Rate Card Set Version is only accessible to an Administrator on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Rate Card Set Version","name":"Fetching a single Rate Card Set Version","isWebhook":false,"pointer":"/paths/~1rate_card_set_versions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Rate Card Set Version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Rate Card Set Version is only accessible to an Administrator on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Set Version objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_set_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_card_set_versions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_set` (RateCardSet) - The Rate Card Set this version belongs to.\n- `rate_card_versions` (RateCardVersion) - The Rate Card Version of each Rate Card defined on the Rate Card Set."}],"pointer":"/paths/~1rate_card_set_versions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rate_card_set_versions/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_set_versions/{id}","href":"rate-card-set-version-(effective-version-by-date)/get rate card set version","openApiOperationId":"Get Rate Card Set Version","summary":"Fetching a single Rate Card Set Version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Rate Card Set Version has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}},"schemaId":"schema_523"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_set_versions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_523","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_set_versions/{id}"},{"label":"Updating an existing Rate Card Set Version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-set-version-(effective-version-by-date)/update rate card set version","routeSlug":"/kantata/specification/rate-card-set-version-(effective-version-by-date)/update rate card set version","metadata":{"seo":{"title":"Updating an existing Rate Card Set Version","description":"A Rate Card Set Version can only be modified when the effective date is in the future, or when it is not yetpublished."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Rate Card Set Version","name":"Updating an existing Rate Card Set Version","isWebhook":false,"pointer":"/paths/~1rate_card_set_versions~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Rate Card Set Version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Rate Card Set Version can only be modified when the effective date is in the future, or when it is not yet"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"published."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Set Version objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_set_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_card_set_versions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_set` (RateCardSet) - The Rate Card Set this version belongs to.\n- `rate_card_versions` (RateCardVersion) - The Rate Card Version of each Rate Card defined on the Rate Card Set."}],"pointer":"/paths/~1rate_card_set_versions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_525"}},"schemaId":"schema_525","pointer":"/paths/~1rate_card_set_versions~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rate_card_set_versions/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_525"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_set_versions/{id}","href":"rate-card-set-version-(effective-version-by-date)/update rate card set version","openApiOperationId":"Update Rate Card Set Version","summary":"Updating an existing Rate Card Set Version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_525","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_525"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate Card Set Version has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}},"schemaId":"schema_523"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_set_versions~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_523","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_set_versions/{id}"},{"label":"Deleting an existing Rate Card Set Version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-set-version-(effective-version-by-date)/delete rate card set version","routeSlug":"/kantata/specification/rate-card-set-version-(effective-version-by-date)/delete rate card set version","metadata":{"seo":{"title":"Deleting an existing Rate Card Set Version","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Rate Card Set Version","name":"Deleting an existing Rate Card Set Version","isWebhook":false,"pointer":"/paths/~1rate_card_set_versions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Rate Card Set Version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_card_set_versions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rate_card_set_versions/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/rate_card_set_versions/{id}","href":"rate-card-set-version-(effective-version-by-date)/delete rate card set version","openApiOperationId":"Delete Rate Card Set Version","summary":"Deleting an existing Rate Card Set Version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Rate Card Set Version has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_set_versions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_set_versions/{id}"},{"label":"Publish a Rate Card Set Version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-set-version-(effective-version-by-date)/publish rate card set version","routeSlug":"/kantata/specification/rate-card-set-version-(effective-version-by-date)/publish rate card set version","metadata":{"seo":{"title":"Publish a Rate Card Set Version","description":"Publishing a Rate Card Set Version means activating the version from the set effective date.A Rate Card Set Version can be published to any future date, but cannot be published on the sameeffective date as another Rate Card Set Version on the same Rate Card Set. Once published, a Rate CardSet Version cannot be unpublished."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Publish Rate Card Set Version","name":"Publish a Rate Card Set Version","isWebhook":false,"pointer":"/paths/~1rate_card_set_versions~1{id}~1publish/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publish a Rate Card Set Version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Publishing a Rate Card Set Version means activating the version from the set effective date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Rate Card Set Version can be published to any future date, but cannot be published on the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effective date as another Rate Card Set Version on the same Rate Card Set. Once published, a Rate Card"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set Version cannot be unpublished."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Set Version objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_set_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_card_set_versions~1{id}~1publish/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_set` (RateCardSet) - The Rate Card Set this version belongs to.\n- `rate_card_versions` (RateCardVersion) - The Rate Card Version of each Rate Card defined on the Rate Card Set."}],"pointer":"/paths/~1rate_card_set_versions~1{id}~1publish/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rate_card_set_versions/{id}/publish","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_set_versions/{id}/publish","href":"rate-card-set-version-(effective-version-by-date)/publish rate card set version","openApiOperationId":"Publish Rate Card Set Version","summary":"Publish a Rate Card Set Version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate Card Set Version has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_526"}},"schemaId":"schema_526"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_set_versions~1{id}~1publish/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_526","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_526"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_set_versions/{id}/publish"}],"content":{"contentType":"group","meta":{"name":"Rate Card Set Version (Effective version by Date)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rate Card Set Version (Effective version by Date)","showPageActions":true},{"nodeType":"markdoc","content":"In the Rate Card system, Rate Card Set Versions represent snapshots of a Rate Card Set,\nthat take effect on the set published date. A Rate Card Set Version owns a copy of each Rate Card Version\nof a Rate Card in the associated Rate Card Set.\n\nRate Card Roles can only be accessed, edited, or published by an Administrator on the account.\n\nSince Rate Cards and Rate Card Versions are immutable after they are published and in use, generating a\nRate Card Set Version is the correct process for making any changes. When a new Rate Card Set Version\nis created or cloned, all of the Rate Card Versions from the old Rate Card Set Version are copied\nto a new one."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rate_card_set_versions","summary":"Fetching a list of Rate Card Set Versions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-card-set-version-(effective-version-by-date)/get rate card set versions","deprecated":false},{"title":"/rate_card_set_versions","summary":"Creating a new Rate Card Set Version","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rate-card-set-version-(effective-version-by-date)/create rate card set version","deprecated":false},{"title":"/rate_card_set_versions/{id}","summary":"Fetching a single Rate Card Set Version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-card-set-version-(effective-version-by-date)/get rate card set version","deprecated":false},{"title":"/rate_card_set_versions/{id}","summary":"Updating an existing Rate Card Set Version","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rate-card-set-version-(effective-version-by-date)/update rate card set version","deprecated":false},{"title":"/rate_card_set_versions/{id}","summary":"Deleting an existing Rate Card Set Version","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rate-card-set-version-(effective-version-by-date)/delete rate card set version","deprecated":false},{"title":"/rate_card_set_versions/{id}/publish","summary":"Publish a Rate Card Set Version","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rate-card-set-version-(effective-version-by-date)/publish rate card set version","deprecated":false}]}]}]}]}},{"type":"group","label":"Rate Card Sets (Group of Rate Cards)","link":"/kantata/specification/rate-card-sets-(group-of-rate-cards)","routeSlug":"/kantata/specification/rate-card-sets-(group-of-rate-cards)","items":[{"label":"Fetching a list of Rate Card Sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-sets-(group-of-rate-cards)/get rate card sets","routeSlug":"/kantata/specification/rate-card-sets-(group-of-rate-cards)/get rate card sets","metadata":{"seo":{"title":"Fetching a list of Rate Card Sets","description":"Rate Card Sets are only accessible to users with Financial access (Project Lead or higher) on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Rate Card Sets","name":"Fetching a list of Rate Card Sets","isWebhook":false,"pointer":"/paths/~1rate_card_sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Rate Card Sets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Card Sets are only accessible to users with Financial access (Project Lead or higher) on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An initial request to this endpoint, will generate an account default Rate Card Set and a create a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Card Set Version. This account default Rate Card Set will include a separate Rate Card for every currency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used in projects on the user's account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"active","in":"query","schemaId":"schema_305","description":"Includes only Rate Card Sets with published Rate Card Set Versions."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"has_active_currency","in":"query","schemaId":"schema_304","description":"Includes only Rate Card Sets that have a rate card with the specified currency and belong to\na published Rate Card Set Version."},{"name":"has_currency","in":"query","schemaId":"schema_304","description":"Includes only Rate Card Sets that have a rate card with the specified currency."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_set_versions` (RateCardSetVersion) - Rate Card Set Versions belonging to the Rate Card Set.\n- `rate_cards` (RateCard) - Rate Cards (currencies) belonging to the Rate Card Set.\n- `workspace_groups` (WorkspaceGroup) - Groups associated with the Rate Card Set."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Includes only Rate Card Sets with a title matching the specified term."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_335","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `title:asc`, and `title:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"workspace_groups","in":"query","schemaId":"schema_304","description":"Filter rate card sets by their associated workspace groups. Provide a comma-separated list of workspace group IDs, for example `10,20`."}],"pointer":"/paths/~1rate_card_sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rate_card_sets","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"active","in":"query","schemaId":"schema_305"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"has_active_currency","in":"query","schemaId":"schema_304"},{"name":"has_currency","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_335"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"workspace_groups","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_sets","href":"rate-card-sets-(group-of-rate-cards)/get rate card sets","openApiOperationId":"Get Rate Card Sets","summary":"Fetching a list of Rate Card Sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Rate Card Sets have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_sets"},{"label":"Creating a new Rate Card Set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-sets-(group-of-rate-cards)/create rate card set","routeSlug":"/kantata/specification/rate-card-sets-(group-of-rate-cards)/create rate card set","metadata":{"seo":{"title":"Creating a new Rate Card Set","description":"This endpoint returns structured Rate Card Set objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the rate_card_sets top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Rate Card Set","name":"Creating a new Rate Card Set","isWebhook":false,"pointer":"/paths/~1rate_card_sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Rate Card Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clone_version_id","in":"query","schemaId":"schema_313","description":"The ID of the existing Rate Card Set Version to be cloned.\nCloning creates a Rate Card Set that contains the following:\n - A clone of the specified Rate Card Set Version.\n - A clone of all the associations of the specified Rate Card Set Version.\n - A clone of all the Rate Cards belonging to the Rate Card Set for the specified Rate Card Set Version."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_set_versions` (RateCardSetVersion) - Rate Card Set Versions belonging to the Rate Card Set.\n- `rate_cards` (RateCard) - Rate Cards (currencies) belonging to the Rate Card Set.\n- `workspace_groups` (WorkspaceGroup) - Groups associated with the Rate Card Set."}],"pointer":"/paths/~1rate_card_sets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_528"}},"schemaId":"schema_528","pointer":"/paths/~1rate_card_sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rate_card_sets","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"clone_version_id","in":"query","required":false,"schemaId":"schema_313"},{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_528"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_sets","href":"rate-card-sets-(group-of-rate-cards)/create rate card set","openApiOperationId":"Create Rate Card Set","summary":"Creating a new Rate Card Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_528","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_528"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate Card Set has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_sets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_sets"},{"label":"Fetching a single Rate Card Set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-sets-(group-of-rate-cards)/get rate card set","routeSlug":"/kantata/specification/rate-card-sets-(group-of-rate-cards)/get rate card set","metadata":{"seo":{"title":"Fetching a single Rate Card Set","description":"A Rate Card Set can only be accessed by users with Financial access (Project Lead or higher) on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Rate Card Set","name":"Fetching a single Rate Card Set","isWebhook":false,"pointer":"/paths/~1rate_card_sets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Rate Card Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Rate Card Set can only be accessed by users with Financial access (Project Lead or higher) on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_card_sets~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_set_versions` (RateCardSetVersion) - Rate Card Set Versions belonging to the Rate Card Set.\n- `rate_cards` (RateCard) - Rate Cards (currencies) belonging to the Rate Card Set.\n- `workspace_groups` (WorkspaceGroup) - Groups associated with the Rate Card Set."}],"pointer":"/paths/~1rate_card_sets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rate_card_sets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_sets/{id}","href":"rate-card-sets-(group-of-rate-cards)/get rate card set","openApiOperationId":"Get Rate Card Set","summary":"Fetching a single Rate Card Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Rate Card Set has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_sets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_sets/{id}"},{"label":"Updating an existing Rate Card Set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-sets-(group-of-rate-cards)/update rate card set","routeSlug":"/kantata/specification/rate-card-sets-(group-of-rate-cards)/update rate card set","metadata":{"seo":{"title":"Updating an existing Rate Card Set","description":"This endpoint returns structured Rate Card Set objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the rate_card_sets top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Rate Card Set","name":"Updating an existing Rate Card Set","isWebhook":false,"pointer":"/paths/~1rate_card_sets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Rate Card Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Set objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_sets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_card_sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card_set_versions` (RateCardSetVersion) - Rate Card Set Versions belonging to the Rate Card Set.\n- `rate_cards` (RateCard) - Rate Cards (currencies) belonging to the Rate Card Set.\n- `workspace_groups` (WorkspaceGroup) - Groups associated with the Rate Card Set."}],"pointer":"/paths/~1rate_card_sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_529"}},"schemaId":"schema_529","pointer":"/paths/~1rate_card_sets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rate_card_sets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_529"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_sets/{id}","href":"rate-card-sets-(group-of-rate-cards)/update rate card set","openApiOperationId":"Update Rate Card Set","summary":"Updating an existing Rate Card Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_529","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_529"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate Card Set has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_sets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_sets/{id}"},{"label":"Deleting an existing Rate Card Set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-sets-(group-of-rate-cards)/delete rate card set","routeSlug":"/kantata/specification/rate-card-sets-(group-of-rate-cards)/delete rate card set","metadata":{"seo":{"title":"Deleting an existing Rate Card Set","description":"A Rate Card Set cannot be deleted if:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Rate Card Set","name":"Deleting an existing Rate Card Set","isWebhook":false,"pointer":"/paths/~1rate_card_sets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Rate Card Set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Rate Card Set cannot be deleted if:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Rate Card Set is the account default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Rate Card belonging to the Rate Card Set is being used by a project."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_card_sets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rate_card_sets/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/rate_card_sets/{id}","href":"rate-card-sets-(group-of-rate-cards)/delete rate card set","openApiOperationId":"Delete Rate Card Set","summary":"Deleting an existing Rate Card Set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Rate Card Set has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_sets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_sets/{id}"}],"content":{"contentType":"group","meta":{"name":"Rate Card Sets (Group of Rate Cards)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rate Card Sets (Group of Rate Cards)","showPageActions":true},{"nodeType":"markdoc","content":"A Rate Card Set represents a group of Rate Cards with multiple currencies that\ncan be bundled together. A Rate Card Set belongs to an account and can have several Rate Card Set Versions, each representing the\neffective version for a specified date.\n\nIf the Rate Card feature is enabled, an account will always have an account default Rate Card Set. Rate\nCards belonging to the account default Rate Card Set are applied to projects by default when a Rate Card\nis not explicitly set.\n\nAdditional custom Rate Card Sets can be created after the Rate Cards feature has been enabled on the\naccount. This can be done by making a request to the activations\nendpoint."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rate_card_sets","summary":"Fetching a list of Rate Card Sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-card-sets-(group-of-rate-cards)/get rate card sets","deprecated":false},{"title":"/rate_card_sets","summary":"Creating a new Rate Card Set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rate-card-sets-(group-of-rate-cards)/create rate card set","deprecated":false},{"title":"/rate_card_sets/{id}","summary":"Fetching a single Rate Card Set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-card-sets-(group-of-rate-cards)/get rate card set","deprecated":false},{"title":"/rate_card_sets/{id}","summary":"Updating an existing Rate Card Set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rate-card-sets-(group-of-rate-cards)/update rate card set","deprecated":false},{"title":"/rate_card_sets/{id}","summary":"Deleting an existing Rate Card Set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rate-card-sets-(group-of-rate-cards)/delete rate card set","deprecated":false}]}]}]}]}},{"type":"group","label":"Rate Card Table Rows","link":"/kantata/specification/rate-card-table-rows","routeSlug":"/kantata/specification/rate-card-table-rows","items":[{"label":"Fetch Rate Card Table Rows","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-table-rows/get rate card table rows for set version","routeSlug":"/kantata/specification/rate-card-table-rows/get rate card table rows for set version","metadata":{"seo":{"title":"Fetch Rate Card Table Rows","description":"Returns all Rate Card Table Rows for a specified Rate Card Set Version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Rate Card Table Rows For Set Version","name":"Fetch Rate Card Table Rows","isWebhook":false,"pointer":"/paths/~1rate_card_set_versions~1{rate_card_set_version_id}~1rate_card_table_rows/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch Rate Card Table Rows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all Rate Card Table Rows for a specified Rate Card Set Version."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rate_card_set_version_id","in":"path","schemaId":"schema_316","description":"The ID of the Rate card set version.","required":true}],"pointer":"/paths/~1rate_card_set_versions~1{rate_card_set_version_id}~1rate_card_table_rows/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"rate_card_set_version_id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows","href":"rate-card-table-rows/get rate card table rows for set version","openApiOperationId":"Get Rate Card Table Rows For Set Version","summary":"Fetch Rate Card Table Rows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Rate Card Table Rows have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}},"schemaId":"schema_530"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_set_versions~1{rate_card_set_version_id}~1rate_card_table_rows/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_530","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows"},{"label":"Delete a Rate Card Table Row","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-table-rows/delete rate card table row","routeSlug":"/kantata/specification/rate-card-table-rows/delete rate card table row","metadata":{"seo":{"title":"Delete a Rate Card Table Row","description":"Deletes all Rate Card Roles for a specified Rate Card Set Version and Role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Rate Card Table Row","name":"Delete a Rate Card Table Row","isWebhook":false,"pointer":"/paths/~1rate_card_set_versions~1{rate_card_set_version_id}~1rate_card_table_rows~1{role_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Rate Card Table Row","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes all Rate Card Roles for a specified Rate Card Set Version and Role."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rate_card_set_version_id","in":"path","schemaId":"schema_316","description":"The ID of the Rate card set version.","required":true},{"name":"role_id","in":"path","schemaId":"schema_316","description":"The ID of the Role.","required":true}],"pointer":"/paths/~1rate_card_set_versions~1{rate_card_set_version_id}~1rate_card_table_rows~1{role_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows/{role_id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"rate_card_set_version_id","in":"path","required":true,"schemaId":"schema_316"},{"name":"role_id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows/{role_id}","href":"rate-card-table-rows/delete rate card table row","openApiOperationId":"Delete Rate Card Table Row","summary":"Delete a Rate Card Table Row"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Rate Card Table Row has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_set_versions~1{rate_card_set_version_id}~1rate_card_table_rows~1{role_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows/{role_id}"},{"label":"Create or Update Rate Card Table Row","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-table-rows/create or update rate table row","routeSlug":"/kantata/specification/rate-card-table-rows/create or update rate table row","metadata":{"seo":{"title":"Create or Update Rate Card Table Row","description":"Creates or updates a Rate Card Table Row for a specified Rate Card Set Version and Role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Or Update Rate Table Row","name":"Create or Update Rate Card Table Row","isWebhook":false,"pointer":"/paths/~1rate_card_set_versions~1{rate_card_set_version_id}~1rate_card_table_rows~1{role_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or Update Rate Card Table Row","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates a Rate Card Table Row for a specified Rate Card Set Version and Role."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rate_card_set_version_id","in":"path","schemaId":"schema_316","description":"The ID of the Rate card set version.","required":true},{"name":"role_id","in":"path","schemaId":"schema_316","description":"The ID of the Role.","required":true}],"pointer":"/paths/~1rate_card_set_versions~1{rate_card_set_version_id}~1rate_card_table_rows~1{role_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531","pointer":"/paths/~1rate_card_set_versions~1{rate_card_set_version_id}~1rate_card_table_rows~1{role_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows/{role_id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"rate_card_set_version_id","in":"path","required":true,"schemaId":"schema_316"},{"name":"role_id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_531"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows/{role_id}","href":"rate-card-table-rows/create or update rate table row","openApiOperationId":"Create Or Update Rate Table Row","summary":"Create or Update Rate Card Table Row"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_531"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate Card Table Row has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}},"schemaId":"schema_530"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_set_versions~1{rate_card_set_version_id}~1rate_card_table_rows~1{role_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_530","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows/{role_id}"}],"content":{"contentType":"group","meta":{"name":"Rate Card Table Rows"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rate Card Table Rows","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each Rate Card Table Row represents a role and its rates and currencies"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for a specific "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Rate-Card-Set-Version-(Effective-version-by-Date)"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Card Set Version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows","summary":"Fetch Rate Card Table Rows","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-card-table-rows/get rate card table rows for set version","deprecated":false},{"title":"/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows/{role_id}","summary":"Delete a Rate Card Table Row","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rate-card-table-rows/delete rate card table row","deprecated":false},{"title":"/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows/{role_id}","summary":"Create or Update Rate Card Table Row","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rate-card-table-rows/create or update rate table row","deprecated":false}]}]}]}]}},{"type":"group","label":"Rate Card Versions","link":"/kantata/specification/rate-card-versions","routeSlug":"/kantata/specification/rate-card-versions","items":[{"label":"Fetching a list of Rate Card Versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-versions/get rate card versions","routeSlug":"/kantata/specification/rate-card-versions/get rate card versions","metadata":{"seo":{"title":"Fetching a list of Rate Card Versions","description":"Rate Card Versions are only accessible by Administrators on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Rate Card Versions","name":"Fetching a list of Rate Card Versions","isWebhook":false,"pointer":"/paths/~1rate_card_versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Rate Card Versions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Card Versions are only accessible by Administrators on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Version objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"effective_on_date","in":"query","schemaId":"schema_368","description":"Returns Rate Card Versions that are effective on the requested date.\nThe date should be in `` eg. `'2014-02-25'`. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card` (RateCard) - The Rate Card to which this version belongs.\n- `rate_card_roles` (RateCardRole) - The Rate Card Roles owned by this Rate Card Version.\n- `rate_card_set_version` (RateCardSetVersion) - The Rate Card Set Version to which this version belongs."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"rate_card_id","in":"query","schemaId":"schema_313","description":"Restricts Rate Card Versions to the specified Rate Card ID."},{"name":"rate_card_set_id","in":"query","schemaId":"schema_313","description":"Restricts Rate Card Versions to the specified Rate Card Set ID."},{"name":"rate_card_set_version_id","in":"query","schemaId":"schema_313","description":"Restricts Rate Card Versions to the specified Rate Card Set Version ID."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1rate_card_versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rate_card_versions","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"effective_on_date","in":"query","schemaId":"schema_368"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"rate_card_id","in":"query","schemaId":"schema_313"},{"name":"rate_card_set_id","in":"query","schemaId":"schema_313"},{"name":"rate_card_set_version_id","in":"query","schemaId":"schema_313"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_versions","href":"rate-card-versions/get rate card versions","openApiOperationId":"Get Rate Card Versions","summary":"Fetching a list of Rate Card Versions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Rate Card Versions have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_versions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_versions"},{"label":"Fetching a single Rate Card Version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-versions/get rate card version","routeSlug":"/kantata/specification/rate-card-versions/get rate card version","metadata":{"seo":{"title":"Fetching a single Rate Card Version","description":"Rate Card Versions are only accessible by Administrators on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Rate Card Version","name":"Fetching a single Rate Card Version","isWebhook":false,"pointer":"/paths/~1rate_card_versions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Rate Card Version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Card Versions are only accessible by Administrators on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Version objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_card_versions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card` (RateCard) - The Rate Card to which this version belongs.\n- `rate_card_roles` (RateCardRole) - The Rate Card Roles owned by this Rate Card Version.\n- `rate_card_set_version` (RateCardSetVersion) - The Rate Card Set Version to which this version belongs."}],"pointer":"/paths/~1rate_card_versions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rate_card_versions/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_versions/{id}","href":"rate-card-versions/get rate card version","openApiOperationId":"Get Rate Card Version","summary":"Fetching a single Rate Card Version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Rate Card Version has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_versions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_versions/{id}"},{"label":"Updating an existing Rate Card Version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-card-versions/update rate card version","routeSlug":"/kantata/specification/rate-card-versions/update rate card version","metadata":{"seo":{"title":"Updating an existing Rate Card Version","description":"Rate Card Versions can only be modified by Administrators on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Rate Card Version","name":"Updating an existing Rate Card Version","isWebhook":false,"pointer":"/paths/~1rate_card_versions~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Rate Card Version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Card Versions can only be modified by Administrators on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card Version objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_card_versions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `rate_card` (RateCard) - The Rate Card to which this version belongs.\n- `rate_card_roles` (RateCardRole) - The Rate Card Roles owned by this Rate Card Version.\n- `rate_card_set_version` (RateCardSetVersion) - The Rate Card Set Version to which this version belongs."}],"pointer":"/paths/~1rate_card_versions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_533"}},"schemaId":"schema_533","pointer":"/paths/~1rate_card_versions~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rate_card_versions/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_533"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_card_versions/{id}","href":"rate-card-versions/update rate card version","openApiOperationId":"Update Rate Card Version","summary":"Updating an existing Rate Card Version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_533","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_533"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate Card Version has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_card_versions~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_card_versions/{id}"}],"content":{"contentType":"group","meta":{"name":"Rate Card Versions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rate Card Versions","showPageActions":true},{"nodeType":"markdoc","content":"Rate Card Versions represent a snapshot of a Rate Card at a specified point in time. They are used to set the\ndefault rate. Rate Card Versions belong to a Rate Card Set Version and own many Rate Card Roles.\n\nRate Card Versions cannot be explicitly created. This is done through the creation of Rate Cards or\nRate Card Set Versions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rate_card_versions","summary":"Fetching a list of Rate Card Versions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-card-versions/get rate card versions","deprecated":false},{"title":"/rate_card_versions/{id}","summary":"Fetching a single Rate Card Version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-card-versions/get rate card version","deprecated":false},{"title":"/rate_card_versions/{id}","summary":"Updating an existing Rate Card Version","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rate-card-versions/update rate card version","deprecated":false}]}]}]}]}},{"type":"group","label":"Rate Cards (Multiple Currencies)","link":"/kantata/specification/rate-cards-(multiple-currencies)","routeSlug":"/kantata/specification/rate-cards-(multiple-currencies)","items":[{"label":"Fetching a list of Rate Cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-cards-(multiple-currencies)/get rate cards","routeSlug":"/kantata/specification/rate-cards-(multiple-currencies)/get rate cards","metadata":{"seo":{"title":"Fetching a list of Rate Cards","description":"Returns Rate Cards on every Rate Card Set belonging to the account of the user that is logged-in.This endpoint is only accessible to users with Financial access (Project Lead or higher) on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Rate Cards","name":"Fetching a list of Rate Cards","isWebhook":false,"pointer":"/paths/~1rate_cards/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Rate Cards","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns Rate Cards on every Rate Card Set belonging to the account of the user that is logged-in."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is only accessible to users with Financial access (Project Lead or higher) on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_cards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"active","in":"query","schemaId":"schema_305","description":"Returns Rate Cards that have been published."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"currencies","in":"query","schemaId":"schema_304","description":"Restricts Rate Cards to the specified currencies e.g. 'USD,CAD,GBP'."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `effective_rate_card_version` (RateCardVersion) - Returns todays effective Rate Card Version for the user that is logged-in. Must be used with the `only` parameter.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `rate_card_set` (RateCardSet) - The Rate Card Set to which this Rate Card belongs.\n- `rate_card_versions` (RateCardVersion) - Includes only Rate Card Versions which this Rate Card owns."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Returns rate cards whose set title matches the provided text (substring)."},{"name":"matching_title_or_currency","in":"query","schemaId":"schema_304","description":"Returns rate cards matching the provided text against either the set title or the currency code (substring)."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"rate_card_set_id","in":"query","schemaId":"schema_313","description":"Restricts Rate Cards to the specified Rate Card Set."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1rate_cards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rate_cards","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"active","in":"query","schemaId":"schema_305"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"currencies","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"matching_title_or_currency","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"rate_card_set_id","in":"query","schemaId":"schema_313"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_cards","href":"rate-cards-(multiple-currencies)/get rate cards","openApiOperationId":"Get Rate Cards","summary":"Fetching a list of Rate Cards"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Rate Cards have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_cards/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_cards"},{"label":"Creating a new Rate Card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-cards-(multiple-currencies)/create rate card","routeSlug":"/kantata/specification/rate-cards-(multiple-currencies)/create rate card","metadata":{"seo":{"title":"Creating a new Rate Card","description":"Creating a Rate Card automatically creates a Rate Card Version and associates it with the specifiedRate Card Set Version. If you are adding a Rate Card with a new currency on a custom Rate Card Set, it needs tobe added to the account default Rate Card Set first.When you add a Rate Card with a new currency on a Rate Card Set that already has published Rate Card Setversions, a cloned Rate Card Version will be added to all previous Rate Card Set Versions on the RateCard Set.A Rate Card can only be created by Administrators on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Rate Card","name":"Creating a new Rate Card","isWebhook":false,"pointer":"/paths/~1rate_cards/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Rate Card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating a Rate Card automatically creates a Rate Card Version and associates it with the specified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Card Set Version. If you are adding a Rate Card with a new currency on a custom Rate Card Set, it needs to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be added to the account default Rate Card Set first."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you add a Rate Card with a new currency on a Rate Card Set that already has published Rate Card Set"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"versions, a cloned Rate Card Version will be added to all previous Rate Card Set Versions on the Rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Set."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Rate Card can only be created by Administrators on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_cards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `effective_rate_card_version` (RateCardVersion) - Returns todays effective Rate Card Version for the user that is logged-in. Must be used with the `only` parameter.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `rate_card_set` (RateCardSet) - The Rate Card Set to which this Rate Card belongs.\n- `rate_card_versions` (RateCardVersion) - Includes only Rate Card Versions which this Rate Card owns."}],"pointer":"/paths/~1rate_cards/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_535"}},"schemaId":"schema_535","pointer":"/paths/~1rate_cards/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rate_cards","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_535"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_cards","href":"rate-cards-(multiple-currencies)/create rate card","openApiOperationId":"Create Rate Card","summary":"Creating a new Rate Card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_535","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_535"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate Card has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_cards/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_cards"},{"label":"Fetching a single Rate Card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-cards-(multiple-currencies)/get rate card","routeSlug":"/kantata/specification/rate-cards-(multiple-currencies)/get rate card","metadata":{"seo":{"title":"Fetching a single Rate Card","description":"This endpoint is only accessible to users with Financial access (Project Lead or higher) on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Rate Card","name":"Fetching a single Rate Card","isWebhook":false,"pointer":"/paths/~1rate_cards~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Rate Card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is only accessible to users with Financial access (Project Lead or higher) on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_cards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_cards~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `effective_rate_card_version` (RateCardVersion) - Returns todays effective Rate Card Version for the user that is logged-in. Must be used with the `only` parameter.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `rate_card_set` (RateCardSet) - The Rate Card Set to which this Rate Card belongs.\n- `rate_card_versions` (RateCardVersion) - Includes only Rate Card Versions which this Rate Card owns."}],"pointer":"/paths/~1rate_cards~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rate_cards/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_cards/{id}","href":"rate-cards-(multiple-currencies)/get rate card","openApiOperationId":"Get Rate Card","summary":"Fetching a single Rate Card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Rate Card has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_cards~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_cards/{id}"},{"label":"Updating an existing Rate Card","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-cards-(multiple-currencies)/update rate card","routeSlug":"/kantata/specification/rate-cards-(multiple-currencies)/update rate card","metadata":{"seo":{"title":"Updating an existing Rate Card","description":"A Rate Card can only be editied by an Administrator on the account. The currency of the Rate Cardcannot be changed if it is already in use by a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Rate Card","name":"Updating an existing Rate Card","isWebhook":false,"pointer":"/paths/~1rate_cards~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Rate Card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Rate Card can only be editied by an Administrator on the account. The currency of the Rate Card"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot be changed if it is already in use by a project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Rate Card objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_cards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_cards~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `effective_rate_card_version` (RateCardVersion) - Returns todays effective Rate Card Version for the user that is logged-in. Must be used with the `only` parameter.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `rate_card_set` (RateCardSet) - The Rate Card Set to which this Rate Card belongs.\n- `rate_card_versions` (RateCardVersion) - Includes only Rate Card Versions which this Rate Card owns."}],"pointer":"/paths/~1rate_cards~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_536"}},"schemaId":"schema_536","pointer":"/paths/~1rate_cards~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rate_cards/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_536"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/rate_cards/{id}","href":"rate-cards-(multiple-currencies)/update rate card","openApiOperationId":"Update Rate Card","summary":"Updating an existing Rate Card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_536","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_536"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate Card has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_cards~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_cards/{id}"},{"label":"Deleting an existing Rate Card","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/rate-cards-(multiple-currencies)/delete rate card","routeSlug":"/kantata/specification/rate-cards-(multiple-currencies)/delete rate card","metadata":{"seo":{"title":"Deleting an existing Rate Card","description":"When you delete a Rate Card, its Rate Card Versions and the Rate Card Roles associatedwith the Rate Card Versions will also be deleted. Once a Rate Card is deleted, neither the Rate Card norits associated data is recoverable. A Rate Card cannot be deleted if it is already in use by a project.A Rate Card can only be deleted by an Administrator on the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Rate Card","name":"Deleting an existing Rate Card","isWebhook":false,"pointer":"/paths/~1rate_cards~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Rate Card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you delete a Rate Card, its Rate Card Versions and the Rate Card Roles associated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the Rate Card Versions will also be deleted. Once a Rate Card is deleted, neither the Rate Card nor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"its associated data is recoverable. A Rate Card cannot be deleted if it is already in use by a project."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Rate Card can only be deleted by an Administrator on the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1rate_cards~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rate_cards/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/rate_cards/{id}","href":"rate-cards-(multiple-currencies)/delete rate card","openApiOperationId":"Delete Rate Card","summary":"Deleting an existing Rate Card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Rate Card has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1rate_cards~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/rate_cards/{id}"}],"content":{"contentType":"group","meta":{"name":"Rate Cards (Multiple Currencies)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rate Cards (Multiple Currencies)","showPageActions":true},{"nodeType":"markdoc","content":"Rate Cards belong to a Rate Card Set and represent the currencies in that set. Rate Cards have\nmany Rate Card Versions which represent the effective version of a Rate Card at a specified point of time.\nRate Cards are accessible to users with Financial access (Project Lead or higher) on the account. However, they\ncan only created, modified or deleted by Administrators on the account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rate_cards","summary":"Fetching a list of Rate Cards","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-cards-(multiple-currencies)/get rate cards","deprecated":false},{"title":"/rate_cards","summary":"Creating a new Rate Card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rate-cards-(multiple-currencies)/create rate card","deprecated":false},{"title":"/rate_cards/{id}","summary":"Fetching a single Rate Card","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-cards-(multiple-currencies)/get rate card","deprecated":false},{"title":"/rate_cards/{id}","summary":"Updating an existing Rate Card","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rate-cards-(multiple-currencies)/update rate card","deprecated":false},{"title":"/rate_cards/{id}","summary":"Deleting an existing Rate Card","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rate-cards-(multiple-currencies)/delete rate card","deprecated":false}]}]}]}]}},{"type":"separator","label":"Recommendations","content":null},{"type":"group","label":"Recommendations","link":"/kantata/specification/recommendations","routeSlug":"/kantata/specification/recommendations","items":[{"label":"Fetch Estimate Scenario Resource Recommendations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/recommendations/get estimate scenario resource recommendations","routeSlug":"/kantata/specification/recommendations/get estimate scenario resource recommendations","metadata":{"seo":{"title":"Fetch Estimate Scenario Resource Recommendations","description":"Returns an ordered list of Recommendations (up to 1000) for an estimate scenario resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Estimate Scenario Resource Recommendations","name":"Fetch Estimate Scenario Resource Recommendations","isWebhook":false,"pointer":"/paths/~1recommendations~1estimate_scenario_resource/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch Estimate Scenario Resource Recommendations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an ordered list of Recommendations (up to 1000) for an estimate scenario resource."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_313","description":"The ID of the EstimateScenarioResource for which to retrieve recommendations.","required":true}],"pointer":"/paths/~1recommendations~1estimate_scenario_resource/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recommendations/estimate_scenario_resource","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","required":true,"schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/recommendations/estimate_scenario_resource","href":"recommendations/get estimate scenario resource recommendations","openApiOperationId":"Get Estimate Scenario Resource Recommendations","summary":"Fetch Estimate Scenario Resource Recommendations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Recommendations have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_537"}},"schemaId":"schema_537"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1recommendations~1estimate_scenario_resource/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_537","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_537"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/recommendations/estimate_scenario_resource"}],"content":{"contentType":"group","meta":{"name":"Recommendations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recommendations","showPageActions":true},{"nodeType":"markdoc","content":"A Recommendation suggests a User for an Unnamed Resource (or some other un-staffed position).\nThe system recommends Users based on how well they match the attributes of a\ntarget resource. Attributes include, but are not limited to:\n - Role\n - Skill(s)\n - Single Choice Custom Field(s)\n - Allocation(s)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/recommendations/estimate_scenario_resource","summary":"Fetch Estimate Scenario Resource Recommendations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recommendations/get estimate scenario resource recommendations","deprecated":false}]}]}]}]}},{"type":"separator","label":"Resource Requests","content":null},{"type":"group","label":"Resource Requests","link":"/kantata/specification/resource-requests","routeSlug":"/kantata/specification/resource-requests","items":[{"label":"Fetching a list of Resource Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/resource-requests/get resource requests","routeSlug":"/kantata/specification/resource-requests/get resource requests","metadata":{"seo":{"title":"Fetching a list of Resource Requests","description":"Returns resource requests visible to the logged in user by default. When pending_requests_only filter is setto true, the endpoint returns only pending resource requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Resource Requests","name":"Fetching a list of Resource Requests","isWebhook":false,"pointer":"/paths/~1resource_requests/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Resource Requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns resource requests visible to the logged in user by default. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_requests_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter is set"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to true, the endpoint returns only pending resource requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Resource Requests objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `approvers` (User) - The users available to approver or reject the resource request.\n- `creator` (User) - The person submitting the resource request.\n- `resource` (WorkspaceResource) - The resource the request is intending to assign a user to."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"pending_requests_only","in":"query","schemaId":"schema_305","description":"Returns only the pending resource requests."},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"requests_for_approver","in":"query","schemaId":"schema_304","description":"Returns only the requests where the specified user is the approver."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1resource_requests/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/resource_requests","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"pending_requests_only","in":"query","schemaId":"schema_305"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"requests_for_approver","in":"query","schemaId":"schema_304"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/resource_requests","href":"resource-requests/get resource requests","openApiOperationId":"Get Resource Requests","summary":"Fetching a list of Resource Requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Resource Requests have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_538"}},"schemaId":"schema_538"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1resource_requests/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_538","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_538"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/resource_requests"},{"label":"Creating a new Resource Requests","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/resource-requests/create resource request","routeSlug":"/kantata/specification/resource-requests/create resource request","metadata":{"seo":{"title":"Creating a new Resource Requests","description":"This endpoint returns structured Resource Requests objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the resource_requests top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Resource Request","name":"Creating a new Resource Requests","isWebhook":false,"pointer":"/paths/~1resource_requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Resource Requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Resource Requests objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `approvers` (User) - The users available to approver or reject the resource request.\n- `creator` (User) - The person submitting the resource request.\n- `resource` (WorkspaceResource) - The resource the request is intending to assign a user to."}],"pointer":"/paths/~1resource_requests/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","pointer":"/paths/~1resource_requests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/resource_requests","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_539"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/resource_requests","href":"resource-requests/create resource request","openApiOperationId":"Create Resource Request","summary":"Creating a new Resource Requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_539"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource Requests has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_538"}},"schemaId":"schema_538"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1resource_requests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_538","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_538"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/resource_requests"},{"label":"Fetching a single Resource Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/resource-requests/get resource request","routeSlug":"/kantata/specification/resource-requests/get resource request","metadata":{"seo":{"title":"Fetching a single Resource Requests","description":"This endpoint returns structured Resource Requests objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the resource_requests top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Resource Request","name":"Fetching a single Resource Requests","isWebhook":false,"pointer":"/paths/~1resource_requests~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Resource Requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Resource Requests objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1resource_requests~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `approvers` (User) - The users available to approver or reject the resource request.\n- `creator` (User) - The person submitting the resource request.\n- `resource` (WorkspaceResource) - The resource the request is intending to assign a user to."}],"pointer":"/paths/~1resource_requests~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/resource_requests/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/resource_requests/{id}","href":"resource-requests/get resource request","openApiOperationId":"Get Resource Request","summary":"Fetching a single Resource Requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Resource Requests has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_538"}},"schemaId":"schema_538"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1resource_requests~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_538","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_538"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/resource_requests/{id}"},{"label":"Updating an existing Resource Requests","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/resource-requests/update resource request","routeSlug":"/kantata/specification/resource-requests/update resource request","metadata":{"seo":{"title":"Updating an existing Resource Requests","description":"This endpoint returns structured Resource Requests objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the resource_requests top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Resource Request","name":"Updating an existing Resource Requests","isWebhook":false,"pointer":"/paths/~1resource_requests~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Resource Requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Resource Requests objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1resource_requests~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `approvers` (User) - The users available to approver or reject the resource request.\n- `creator` (User) - The person submitting the resource request.\n- `resource` (WorkspaceResource) - The resource the request is intending to assign a user to."}],"pointer":"/paths/~1resource_requests~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_540"}},"schemaId":"schema_540","pointer":"/paths/~1resource_requests~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/resource_requests/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_540"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/resource_requests/{id}","href":"resource-requests/update resource request","openApiOperationId":"Update Resource Request","summary":"Updating an existing Resource Requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_540","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_540"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource Requests has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_538"}},"schemaId":"schema_538"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1resource_requests~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_538","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_538"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/resource_requests/{id}"},{"label":"Update Resource Request Approver","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/resource-requests/update resource request approver","routeSlug":"/kantata/specification/resource-requests/update resource request approver","metadata":{"seo":{"title":"Update Resource Request Approver","description":"This endpoint returns structured Resource Requests objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the resource_requests top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Resource Request Approver","name":"Update Resource Request Approver","isWebhook":false,"pointer":"/paths/~1resource_requests~1{id}~1update_approver/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Resource Request Approver","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Resource Requests objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1resource_requests~1{id}~1update_approver/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `approvers` (User) - The users available to approver or reject the resource request.\n- `creator` (User) - The person submitting the resource request.\n- `resource` (WorkspaceResource) - The resource the request is intending to assign a user to."}],"pointer":"/paths/~1resource_requests~1{id}~1update_approver/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_541"}},"schemaId":"schema_541","pointer":"/paths/~1resource_requests~1{id}~1update_approver/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/resource_requests/{id}/update_approver","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_541"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/resource_requests/{id}/update_approver","href":"resource-requests/update resource request approver","openApiOperationId":"Update Resource Request Approver","summary":"Update Resource Request Approver"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_541","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_541"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource Requests has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_538"}},"schemaId":"schema_538"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1resource_requests~1{id}~1update_approver/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_538","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_538"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/resource_requests/{id}/update_approver"}],"content":{"contentType":"group","meta":{"name":"Resource Requests"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resource Requests","showPageActions":true},{"nodeType":"markdoc","content":"Resource Requests are used as a method for a requestor to ask an approver to staff a resource.\nResource Requests are associated to a workspace resource and must have an approver associated."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/resource_requests","summary":"Fetching a list of Resource Requests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/resource-requests/get resource requests","deprecated":false},{"title":"/resource_requests","summary":"Creating a new Resource Requests","prefix":{"name":"post","color":"post"},"badges":[],"link":"/resource-requests/create resource request","deprecated":false},{"title":"/resource_requests/{id}","summary":"Fetching a single Resource Requests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/resource-requests/get resource request","deprecated":false},{"title":"/resource_requests/{id}","summary":"Updating an existing Resource Requests","prefix":{"name":"put","color":"put"},"badges":[],"link":"/resource-requests/update resource request","deprecated":false},{"title":"/resource_requests/{id}/update_approver","summary":"Update Resource Request Approver","prefix":{"name":"put","color":"put"},"badges":[],"link":"/resource-requests/update resource request approver","deprecated":false}]}]}]}]}},{"type":"separator","label":"Scheduling","content":null},{"type":"group","label":"Holiday Calendar Associations","link":"/kantata/specification/holiday-calendar-associations","routeSlug":"/kantata/specification/holiday-calendar-associations","items":[{"label":"Fetching a list of Holiday Calendar Associations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendar-associations/get holiday calendar associations","routeSlug":"/kantata/specification/holiday-calendar-associations/get holiday calendar associations","metadata":{"seo":{"title":"Fetching a list of Holiday Calendar Associations","description":"This endpoint returns structured Holiday Calendar Association objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holiday_calendar_associations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Holiday Calendar Associations","name":"Fetching a list of Holiday Calendar Associations","isWebhook":false,"pointer":"/paths/~1holiday_calendar_associations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Holiday Calendar Associations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday Calendar Association objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holiday_calendar_associations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"by_holiday_calendar_id","in":"query","schemaId":"schema_313","description":"Show only Holiday Calendar Associations that are associated with a specific Holiday Calendar."},{"name":"by_holiday_name","in":"query","schemaId":"schema_304","description":"Show only Holiday Calendar Associations associated with Holidays that have a name which matches the search parameter."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `holiday` (Holiday) - The Holiday associated with this HolidayCalendarAssociation.\n- `holiday_calendar` (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarAssociation."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1holiday_calendar_associations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/holiday_calendar_associations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"by_holiday_calendar_id","in":"query","schemaId":"schema_313"},{"name":"by_holiday_name","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holiday_calendar_associations","href":"holiday-calendar-associations/get holiday calendar associations","openApiOperationId":"Get Holiday Calendar Associations","summary":"Fetching a list of Holiday Calendar Associations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Holiday Calendar Associations have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_542"}},"schemaId":"schema_542"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendar_associations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_542"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendar_associations"},{"label":"Creating a new Holiday Calendar Association","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendar-associations/create holiday calendar association","routeSlug":"/kantata/specification/holiday-calendar-associations/create holiday calendar association","metadata":{"seo":{"title":"Creating a new Holiday Calendar Association","description":"This endpoint returns structured Holiday Calendar Association objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holiday_calendar_associations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Holiday Calendar Association","name":"Creating a new Holiday Calendar Association","isWebhook":false,"pointer":"/paths/~1holiday_calendar_associations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Holiday Calendar Association","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday Calendar Association objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holiday_calendar_associations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `holiday` (Holiday) - The Holiday associated with this HolidayCalendarAssociation.\n- `holiday_calendar` (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarAssociation."}],"pointer":"/paths/~1holiday_calendar_associations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_543"}},"schemaId":"schema_543","pointer":"/paths/~1holiday_calendar_associations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/holiday_calendar_associations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_543"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holiday_calendar_associations","href":"holiday-calendar-associations/create holiday calendar association","openApiOperationId":"Create Holiday Calendar Association","summary":"Creating a new Holiday Calendar Association"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_543","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_543"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Holiday Calendar Association has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_542"}},"schemaId":"schema_542"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendar_associations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_542"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendar_associations"},{"label":"Fetching a single Holiday Calendar Association","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendar-associations/get holiday calendar association","routeSlug":"/kantata/specification/holiday-calendar-associations/get holiday calendar association","metadata":{"seo":{"title":"Fetching a single Holiday Calendar Association","description":"This endpoint returns structured Holiday Calendar Association objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holiday_calendar_associations top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Holiday Calendar Association","name":"Fetching a single Holiday Calendar Association","isWebhook":false,"pointer":"/paths/~1holiday_calendar_associations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Holiday Calendar Association","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday Calendar Association objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holiday_calendar_associations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1holiday_calendar_associations~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `holiday` (Holiday) - The Holiday associated with this HolidayCalendarAssociation.\n- `holiday_calendar` (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarAssociation."}],"pointer":"/paths/~1holiday_calendar_associations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/holiday_calendar_associations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holiday_calendar_associations/{id}","href":"holiday-calendar-associations/get holiday calendar association","openApiOperationId":"Get Holiday Calendar Association","summary":"Fetching a single Holiday Calendar Association"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Holiday Calendar Association has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_542"}},"schemaId":"schema_542"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendar_associations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_542"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendar_associations/{id}"},{"label":"Deleting an existing Holiday Calendar Association","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendar-associations/delete holiday calendar association","routeSlug":"/kantata/specification/holiday-calendar-associations/delete holiday calendar association","metadata":{"seo":{"title":"Deleting an existing Holiday Calendar Association","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Holiday Calendar Association","name":"Deleting an existing Holiday Calendar Association","isWebhook":false,"pointer":"/paths/~1holiday_calendar_associations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Holiday Calendar Association","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1holiday_calendar_associations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/holiday_calendar_associations/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/holiday_calendar_associations/{id}","href":"holiday-calendar-associations/delete holiday calendar association","openApiOperationId":"Delete Holiday Calendar Association","summary":"Deleting an existing Holiday Calendar Association"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Holiday Calendar Association has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendar_associations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendar_associations/{id}"}],"content":{"contentType":"group","meta":{"name":"Holiday Calendar Associations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Holiday Calendar Associations","showPageActions":true},{"nodeType":"markdoc","content":"A Holiday Calendar Association represents the relationship between holiday objects and calendar objects.\nA Holiday can be associated with several different calendars. To associate a holiday with a calendar,\ncreate a Holiday Calendar Assocation."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/holiday_calendar_associations","summary":"Fetching a list of Holiday Calendar Associations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/holiday-calendar-associations/get holiday calendar associations","deprecated":false},{"title":"/holiday_calendar_associations","summary":"Creating a new Holiday Calendar Association","prefix":{"name":"post","color":"post"},"badges":[],"link":"/holiday-calendar-associations/create holiday calendar association","deprecated":false},{"title":"/holiday_calendar_associations/{id}","summary":"Fetching a single Holiday Calendar Association","prefix":{"name":"get","color":"get"},"badges":[],"link":"/holiday-calendar-associations/get holiday calendar association","deprecated":false},{"title":"/holiday_calendar_associations/{id}","summary":"Deleting an existing Holiday Calendar Association","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/holiday-calendar-associations/delete holiday calendar association","deprecated":false}]}]}]}]}},{"type":"group","label":"Holiday Calendar Memberships","link":"/kantata/specification/holiday-calendar-memberships","routeSlug":"/kantata/specification/holiday-calendar-memberships","items":[{"label":"Fetching a list of Holiday Calendar Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendar-memberships/get holiday calendar memberships","routeSlug":"/kantata/specification/holiday-calendar-memberships/get holiday calendar memberships","metadata":{"seo":{"title":"Fetching a list of Holiday Calendar Memberships","description":"This endpoint returns structured Holiday Calendar Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holiday_calendar_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Holiday Calendar Memberships","name":"Fetching a list of Holiday Calendar Memberships","isWebhook":false,"pointer":"/paths/~1holiday_calendar_memberships/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Holiday Calendar Memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday Calendar Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holiday_calendar_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"by_holiday_calendar_id","in":"query","schemaId":"schema_313","description":"Include holiday calendar memberships for the specified holiday calendar ID."},{"name":"by_user_id","in":"query","schemaId":"schema_313","description":"Include holiday calendar memberships for the specified user ID."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `holiday_calendar` (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarMembership.\n- `user` (User) - The User participating in the Holiday Calendar."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_544","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `start_date:asc` and `start_date:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1holiday_calendar_memberships/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/holiday_calendar_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"by_holiday_calendar_id","in":"query","schemaId":"schema_313"},{"name":"by_user_id","in":"query","schemaId":"schema_313"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_544"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holiday_calendar_memberships","href":"holiday-calendar-memberships/get holiday calendar memberships","openApiOperationId":"Get Holiday Calendar Memberships","summary":"Fetching a list of Holiday Calendar Memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Holiday Calendar Memberships have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendar_memberships/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendar_memberships"},{"label":"Creating a new Holiday Calendar Membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendar-memberships/create holiday calendar membership","routeSlug":"/kantata/specification/holiday-calendar-memberships/create holiday calendar membership","metadata":{"seo":{"title":"Creating a new Holiday Calendar Membership","description":"This endpoint returns structured Holiday Calendar Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holiday_calendar_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Holiday Calendar Membership","name":"Creating a new Holiday Calendar Membership","isWebhook":false,"pointer":"/paths/~1holiday_calendar_memberships/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Holiday Calendar Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday Calendar Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holiday_calendar_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `holiday_calendar` (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarMembership.\n- `user` (User) - The User participating in the Holiday Calendar."}],"pointer":"/paths/~1holiday_calendar_memberships/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_546"}},"schemaId":"schema_546","pointer":"/paths/~1holiday_calendar_memberships/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/holiday_calendar_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_546"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holiday_calendar_memberships","href":"holiday-calendar-memberships/create holiday calendar membership","openApiOperationId":"Create Holiday Calendar Membership","summary":"Creating a new Holiday Calendar Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_546","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_546"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Holiday Calendar Membership has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendar_memberships/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendar_memberships"},{"label":"Fetching a single Holiday Calendar Membership","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendar-memberships/get holiday calendar membership","routeSlug":"/kantata/specification/holiday-calendar-memberships/get holiday calendar membership","metadata":{"seo":{"title":"Fetching a single Holiday Calendar Membership","description":"This endpoint returns structured Holiday Calendar Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holiday_calendar_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Holiday Calendar Membership","name":"Fetching a single Holiday Calendar Membership","isWebhook":false,"pointer":"/paths/~1holiday_calendar_memberships~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Holiday Calendar Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday Calendar Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holiday_calendar_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1holiday_calendar_memberships~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `holiday_calendar` (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarMembership.\n- `user` (User) - The User participating in the Holiday Calendar."}],"pointer":"/paths/~1holiday_calendar_memberships~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/holiday_calendar_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holiday_calendar_memberships/{id}","href":"holiday-calendar-memberships/get holiday calendar membership","openApiOperationId":"Get Holiday Calendar Membership","summary":"Fetching a single Holiday Calendar Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Holiday Calendar Membership has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendar_memberships~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendar_memberships/{id}"},{"label":"Updating an existing Holiday Calendar Membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendar-memberships/update holiday calendar membership","routeSlug":"/kantata/specification/holiday-calendar-memberships/update holiday calendar membership","metadata":{"seo":{"title":"Updating an existing Holiday Calendar Membership","description":"This endpoint returns structured Holiday Calendar Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holiday_calendar_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Holiday Calendar Membership","name":"Updating an existing Holiday Calendar Membership","isWebhook":false,"pointer":"/paths/~1holiday_calendar_memberships~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Holiday Calendar Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday Calendar Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holiday_calendar_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1holiday_calendar_memberships~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `holiday_calendar` (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarMembership.\n- `user` (User) - The User participating in the Holiday Calendar."}],"pointer":"/paths/~1holiday_calendar_memberships~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_547"}},"schemaId":"schema_547","pointer":"/paths/~1holiday_calendar_memberships~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/holiday_calendar_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_547"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holiday_calendar_memberships/{id}","href":"holiday-calendar-memberships/update holiday calendar membership","openApiOperationId":"Update Holiday Calendar Membership","summary":"Updating an existing Holiday Calendar Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_547","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_547"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Holiday Calendar Membership has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendar_memberships~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendar_memberships/{id}"},{"label":"Deleting an existing Holiday Calendar Membership","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendar-memberships/delete holiday calendar membership","routeSlug":"/kantata/specification/holiday-calendar-memberships/delete holiday calendar membership","metadata":{"seo":{"title":"Deleting an existing Holiday Calendar Membership","description":"Unlink the calendar from the user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Holiday Calendar Membership","name":"Deleting an existing Holiday Calendar Membership","isWebhook":false,"pointer":"/paths/~1holiday_calendar_memberships~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Holiday Calendar Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlink the calendar from the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1holiday_calendar_memberships~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/holiday_calendar_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/holiday_calendar_memberships/{id}","href":"holiday-calendar-memberships/delete holiday calendar membership","openApiOperationId":"Delete Holiday Calendar Membership","summary":"Deleting an existing Holiday Calendar Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Holiday Calendar Membership has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendar_memberships~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendar_memberships/{id}"}],"content":{"contentType":"group","meta":{"name":"Holiday Calendar Memberships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Holiday Calendar Memberships","showPageActions":true},{"nodeType":"markdoc","content":"A list of all calendars associated to an individual user."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/holiday_calendar_memberships","summary":"Fetching a list of Holiday Calendar Memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/holiday-calendar-memberships/get holiday calendar memberships","deprecated":false},{"title":"/holiday_calendar_memberships","summary":"Creating a new Holiday Calendar Membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/holiday-calendar-memberships/create holiday calendar membership","deprecated":false},{"title":"/holiday_calendar_memberships/{id}","summary":"Fetching a single Holiday Calendar Membership","prefix":{"name":"get","color":"get"},"badges":[],"link":"/holiday-calendar-memberships/get holiday calendar membership","deprecated":false},{"title":"/holiday_calendar_memberships/{id}","summary":"Updating an existing Holiday Calendar Membership","prefix":{"name":"put","color":"put"},"badges":[],"link":"/holiday-calendar-memberships/update holiday calendar membership","deprecated":false},{"title":"/holiday_calendar_memberships/{id}","summary":"Deleting an existing Holiday Calendar Membership","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/holiday-calendar-memberships/delete holiday calendar membership","deprecated":false}]}]}]}]}},{"type":"group","label":"Holiday Calendars","link":"/kantata/specification/holiday-calendars","routeSlug":"/kantata/specification/holiday-calendars","items":[{"label":"Fetching a list of Holiday Calendars","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendars/get holiday calendars","routeSlug":"/kantata/specification/holiday-calendars/get holiday calendars","metadata":{"seo":{"title":"Fetching a list of Holiday Calendars","description":"This endpoint returns structured Holiday Calendar objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holiday_calendars top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Holiday Calendars","name":"Fetching a list of Holiday Calendars","isWebhook":false,"pointer":"/paths/~1holiday_calendars/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Holiday Calendars","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday Calendar objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holiday_calendars"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"matching","in":"query","schemaId":"schema_304","description":"Limits holiday calendars to names matching the specified query."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_548","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `default`, `name:asc`, and `name:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1holiday_calendars/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/holiday_calendars","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_548"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holiday_calendars","href":"holiday-calendars/get holiday calendars","openApiOperationId":"Get Holiday Calendars","summary":"Fetching a list of Holiday Calendars"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Holiday Calendars have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendars/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendars"},{"label":"Creating a new Holiday Calendar","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendars/create holiday calendar","routeSlug":"/kantata/specification/holiday-calendars/create holiday calendar","metadata":{"seo":{"title":"Creating a new Holiday Calendar","description":"This endpoint returns structured Holiday Calendar objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holiday_calendars top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Holiday Calendar","name":"Creating a new Holiday Calendar","isWebhook":false,"pointer":"/paths/~1holiday_calendars/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Holiday Calendar","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday Calendar objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holiday_calendars"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550","pointer":"/paths/~1holiday_calendars/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/holiday_calendars","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_550"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holiday_calendars","href":"holiday-calendars/create holiday calendar","openApiOperationId":"Create Holiday Calendar","summary":"Creating a new Holiday Calendar"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_550"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Holiday Calendar has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendars/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendars"},{"label":"Fetching a single Holiday Calendar","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendars/get holiday calendar","routeSlug":"/kantata/specification/holiday-calendars/get holiday calendar","metadata":{"seo":{"title":"Fetching a single Holiday Calendar","description":"This endpoint returns structured Holiday Calendar objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holiday_calendars top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Holiday Calendar","name":"Fetching a single Holiday Calendar","isWebhook":false,"pointer":"/paths/~1holiday_calendars~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Holiday Calendar","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday Calendar objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holiday_calendars"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1holiday_calendars~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/holiday_calendars/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holiday_calendars/{id}","href":"holiday-calendars/get holiday calendar","openApiOperationId":"Get Holiday Calendar","summary":"Fetching a single Holiday Calendar"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Holiday Calendar has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendars~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendars/{id}"},{"label":"Updating an existing Holiday Calendar","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendars/update holiday calendar","routeSlug":"/kantata/specification/holiday-calendars/update holiday calendar","metadata":{"seo":{"title":"Updating an existing Holiday Calendar","description":"This endpoint returns structured Holiday Calendar objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holiday_calendars top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Holiday Calendar","name":"Updating an existing Holiday Calendar","isWebhook":false,"pointer":"/paths/~1holiday_calendars~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Holiday Calendar","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday Calendar objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holiday_calendars"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1holiday_calendars~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_551"}},"schemaId":"schema_551","pointer":"/paths/~1holiday_calendars~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/holiday_calendars/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_551"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holiday_calendars/{id}","href":"holiday-calendars/update holiday calendar","openApiOperationId":"Update Holiday Calendar","summary":"Updating an existing Holiday Calendar"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_551","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_551"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Holiday Calendar has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendars~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendars/{id}"},{"label":"Deleting an existing Holiday Calendar","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holiday-calendars/delete holiday calendar","routeSlug":"/kantata/specification/holiday-calendars/delete holiday calendar","metadata":{"seo":{"title":"Deleting an existing Holiday Calendar","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Holiday Calendar","name":"Deleting an existing Holiday Calendar","isWebhook":false,"pointer":"/paths/~1holiday_calendars~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Holiday Calendar","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1holiday_calendars~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/holiday_calendars/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/holiday_calendars/{id}","href":"holiday-calendars/delete holiday calendar","openApiOperationId":"Delete Holiday Calendar","summary":"Deleting an existing Holiday Calendar"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Holiday Calendar has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holiday_calendars~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holiday_calendars/{id}"}],"content":{"contentType":"group","meta":{"name":"Holiday Calendars"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Holiday Calendars","showPageActions":true},{"nodeType":"markdoc","content":"Holiday Calendars define the days in which account members are unavailable to work due to company-wide days off."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/holiday_calendars","summary":"Fetching a list of Holiday Calendars","prefix":{"name":"get","color":"get"},"badges":[],"link":"/holiday-calendars/get holiday calendars","deprecated":false},{"title":"/holiday_calendars","summary":"Creating a new Holiday Calendar","prefix":{"name":"post","color":"post"},"badges":[],"link":"/holiday-calendars/create holiday calendar","deprecated":false},{"title":"/holiday_calendars/{id}","summary":"Fetching a single Holiday Calendar","prefix":{"name":"get","color":"get"},"badges":[],"link":"/holiday-calendars/get holiday calendar","deprecated":false},{"title":"/holiday_calendars/{id}","summary":"Updating an existing Holiday Calendar","prefix":{"name":"put","color":"put"},"badges":[],"link":"/holiday-calendars/update holiday calendar","deprecated":false},{"title":"/holiday_calendars/{id}","summary":"Deleting an existing Holiday Calendar","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/holiday-calendars/delete holiday calendar","deprecated":false}]}]}]}]}},{"type":"group","label":"Holidays","link":"/kantata/specification/holidays","routeSlug":"/kantata/specification/holidays","items":[{"label":"Fetching a list of Holidays","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holidays/get holidays","routeSlug":"/kantata/specification/holidays/get holidays","metadata":{"seo":{"title":"Fetching a list of Holidays","description":"This endpoint returns structured Holiday objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holidays top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Holidays","name":"Fetching a list of Holidays","isWebhook":false,"pointer":"/paths/~1holidays/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Holidays","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holidays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `holiday_calendar_associations` (HolidayCalendarAssociation) - The Holiday Calendar Associations for this Holiday."},{"name":"matching","in":"query","schemaId":"schema_304","description":"Includes holidays matching the specified name."},{"name":"not_on_calendars","in":"query","schemaId":"schema_304","description":"Includes holidays not specified in the comma separated list of calendar IDs."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"optional_fields","in":"query","schemaId":"schema_552","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_553","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `start_date:asc` and `start_date:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1holidays/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/holidays","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"matching","in":"query","schemaId":"schema_304"},{"name":"not_on_calendars","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_552","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_553"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holidays","href":"holidays/get holidays","openApiOperationId":"Get Holidays","summary":"Fetching a list of Holidays"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Holidays have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_554"}},"schemaId":"schema_554"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holidays/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_554","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_554"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holidays"},{"label":"Creating a new Holiday","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holidays/create holiday","routeSlug":"/kantata/specification/holidays/create holiday","metadata":{"seo":{"title":"Creating a new Holiday","description":"This endpoint returns structured Holiday objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holidays top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Holiday","name":"Creating a new Holiday","isWebhook":false,"pointer":"/paths/~1holidays/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Holiday","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holidays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `holiday_calendar_associations` (HolidayCalendarAssociation) - The Holiday Calendar Associations for this Holiday."},{"name":"optional_fields","in":"query","schemaId":"schema_552","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1holidays/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_555"}},"schemaId":"schema_555","pointer":"/paths/~1holidays/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/holidays","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_552","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_555"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holidays","href":"holidays/create holiday","openApiOperationId":"Create Holiday","summary":"Creating a new Holiday"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_555","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_555"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Holiday has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_554"}},"schemaId":"schema_554"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holidays/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_554","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_554"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holidays"},{"label":"Fetching a single Holiday","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holidays/get holiday","routeSlug":"/kantata/specification/holidays/get holiday","metadata":{"seo":{"title":"Fetching a single Holiday","description":"This endpoint returns structured Holiday objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holidays top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Holiday","name":"Fetching a single Holiday","isWebhook":false,"pointer":"/paths/~1holidays~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Holiday","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holidays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1holidays~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `holiday_calendar_associations` (HolidayCalendarAssociation) - The Holiday Calendar Associations for this Holiday."},{"name":"optional_fields","in":"query","schemaId":"schema_552","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1holidays~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/holidays/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_552","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holidays/{id}","href":"holidays/get holiday","openApiOperationId":"Get Holiday","summary":"Fetching a single Holiday"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Holiday has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_554"}},"schemaId":"schema_554"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holidays~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_554","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_554"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holidays/{id}"},{"label":"Updating an existing Holiday","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holidays/update holiday","routeSlug":"/kantata/specification/holidays/update holiday","metadata":{"seo":{"title":"Updating an existing Holiday","description":"This endpoint returns structured Holiday objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the holidays top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Holiday","name":"Updating an existing Holiday","isWebhook":false,"pointer":"/paths/~1holidays~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Holiday","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Holiday objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holidays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1holidays~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `holiday_calendar_associations` (HolidayCalendarAssociation) - The Holiday Calendar Associations for this Holiday."},{"name":"optional_fields","in":"query","schemaId":"schema_552","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1holidays~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_555"}},"schemaId":"schema_555","pointer":"/paths/~1holidays~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/holidays/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_552","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_555"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/holidays/{id}","href":"holidays/update holiday","openApiOperationId":"Update Holiday","summary":"Updating an existing Holiday"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_555","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_555"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Holiday has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_554"}},"schemaId":"schema_554"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holidays~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_554","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_554"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holidays/{id}"},{"label":"Deleting an existing Holiday","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/holidays/delete holiday","routeSlug":"/kantata/specification/holidays/delete holiday","metadata":{"seo":{"title":"Deleting an existing Holiday","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Holiday","name":"Deleting an existing Holiday","isWebhook":false,"pointer":"/paths/~1holidays~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Holiday","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1holidays~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/holidays/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/holidays/{id}","href":"holidays/delete holiday","openApiOperationId":"Delete Holiday","summary":"Deleting an existing Holiday"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Holiday has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1holidays~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/holidays/{id}"}],"content":{"contentType":"group","meta":{"name":"Holidays"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Holidays","showPageActions":true},{"nodeType":"markdoc","content":"Holidays are the company-wide days off that have been added to a user's Kantata OX account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/holidays","summary":"Fetching a list of Holidays","prefix":{"name":"get","color":"get"},"badges":[],"link":"/holidays/get holidays","deprecated":false},{"title":"/holidays","summary":"Creating a new Holiday","prefix":{"name":"post","color":"post"},"badges":[],"link":"/holidays/create holiday","deprecated":false},{"title":"/holidays/{id}","summary":"Fetching a single Holiday","prefix":{"name":"get","color":"get"},"badges":[],"link":"/holidays/get holiday","deprecated":false},{"title":"/holidays/{id}","summary":"Updating an existing Holiday","prefix":{"name":"put","color":"put"},"badges":[],"link":"/holidays/update holiday","deprecated":false},{"title":"/holidays/{id}","summary":"Deleting an existing Holiday","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/holidays/delete holiday","deprecated":false}]}]}]}]}},{"type":"group","label":"Time Off Entries","link":"/kantata/specification/time-off-entries","routeSlug":"/kantata/specification/time-off-entries","items":[{"label":"Fetching a list of Time Off Entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/time-off-entries/get time off entries","routeSlug":"/kantata/specification/time-off-entries/get time off entries","metadata":{"seo":{"title":"Fetching a list of Time Off Entries","description":"Returns time off entries which are visible to the user. Items are visible to a user ifthey are on the same account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Time Off Entries","name":"Fetching a list of Time Off Entries","isWebhook":false,"pointer":"/paths/~1time_off_entries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Time Off Entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns time off entries which are visible to the user. Items are visible to a user if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they are on the same account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Time Off Entry objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_off_entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"end_date","in":"query","schemaId":"schema_368","description":"Include only time off entries prior to the specified date. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `role` (Role) - Retrieves the account role of the user associated to the time off entry, if any. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Reference the user associated to the time off entry."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"start_date","in":"query","schemaId":"schema_368","description":"Include only time off entries after the specified date. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"user_id","in":"query","schemaId":"schema_313","description":"Include only time off entries for the specified User ID."},{"name":"user_ids","in":"query","schemaId":"schema_352","description":"Include only time off entries for the specified users. Provide a comma-separated list of user IDs."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Filter for participants of a specific project."}],"pointer":"/paths/~1time_off_entries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/time_off_entries","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"end_date","in":"query","schemaId":"schema_368"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"start_date","in":"query","schemaId":"schema_368"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"user_id","in":"query","schemaId":"schema_313"},{"name":"user_ids","in":"query","schemaId":"schema_352","style":"form","explode":false},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/time_off_entries","href":"time-off-entries/get time off entries","openApiOperationId":"Get Time Off Entries","summary":"Fetching a list of Time Off Entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Time Off Entries have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_556"}},"schemaId":"schema_556"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1time_off_entries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_556","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_556"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/time_off_entries"},{"label":"Creating one or many Time Off Entries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/time-off-entries/create time off entry","routeSlug":"/kantata/specification/time-off-entries/create time off entry","metadata":{"seo":{"title":"Creating one or many Time Off Entries","description":"Creates a single or multiple time off entries for a user. Multiple time off entries can be created forthe same day, in a single request or separate requests. Entries for the same day are combined into onetime off entry. Time off hours cannot exceed the user's possible workday hours for that day."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Time Off Entry","name":"Creating one or many Time Off Entries","isWebhook":false,"pointer":"/paths/~1time_off_entries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating one or many Time Off Entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a single or multiple time off entries for a user. Multiple time off entries can be created for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the same day, in a single request or separate requests. Entries for the same day are combined into one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time off entry. Time off hours cannot exceed the user's possible workday hours for that day."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Time Off Entry objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_off_entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `role` (Role) - Retrieves the account role of the user associated to the time off entry, if any. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Reference the user associated to the time off entry."}],"pointer":"/paths/~1time_off_entries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_557"}},"schemaId":"schema_557","pointer":"/paths/~1time_off_entries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/time_off_entries","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_557"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/time_off_entries","href":"time-off-entries/create time off entry","openApiOperationId":"Create Time Off Entry","summary":"Creating one or many Time Off Entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_557","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_557"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Time Off Entry has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_556"}},"schemaId":"schema_556"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1time_off_entries/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_556","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_556"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/time_off_entries"},{"label":"Delete multiple time off entries","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/time-off-entries/delete time off entries","routeSlug":"/kantata/specification/time-off-entries/delete time off entries","metadata":{"seo":{"title":"Delete multiple time off entries","description":"The IDs of the time off entries to delete can be provided in the ids query parameter or via the request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Time Off Entries","name":"Delete multiple time off entries","isWebhook":false,"pointer":"/paths/~1time_off_entries/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete multiple time off entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs of the time off entries to delete can be provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter or via the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" \"ids\": \"1,2,3\"\n}```\n\nIf any specified time off entries cannot be deleted, the entire request will fail and an error message\nwill be returned that specifies which ones could not be deleted and why.\n\n\nThis endpoint returns structured Time Off Entry objects.\nAs with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array\nand will be indexed by ID in the `time_off_entries` top-level JSON key.\nPlease see our [Response Format](#section/Response-Format) section for more information.","language":"{"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" \"ids\": \"1,2,3\"\n}```\n\nIf any specified time off entries cannot be deleted, the entire request will fail and an error message\nwill be returned that specifies which ones could not be deleted and why.\n\n\nThis endpoint returns structured Time Off Entry objects.\nAs with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array\nand will be indexed by ID in the `time_off_entries` top-level JSON key.\nPlease see our [Response Format](#section/Response-Format) section for more information."},"children":[]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ids","in":"query","schemaId":"schema_304","description":"A comma-separated list of IDs of time off entries. You can provide up to 100 IDs. The IDs can be\nprovided in this query parameter or via the request body."}],"pointer":"/paths/~1time_off_entries/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/time_off_entries","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"ids","in":"query","required":false,"schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/time_off_entries","href":"time-off-entries/delete time off entries","openApiOperationId":"Delete Time Off Entries","summary":"Delete multiple time off entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Time Off Entry has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1time_off_entries/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/time_off_entries"},{"label":"Updating an existing Time Off Entry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/time-off-entries/update time off entry","routeSlug":"/kantata/specification/time-off-entries/update time off entry","metadata":{"seo":{"title":"Updating an existing Time Off Entry","description":"Update a Time Off Entry. Only the hours and external references can be modified. Time off hours cannotexceed the user's possible workday hours for that day."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Time Off Entry","name":"Updating an existing Time Off Entry","isWebhook":false,"pointer":"/paths/~1time_off_entries~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Time Off Entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Time Off Entry. Only the hours and external references can be modified. Time off hours cannot"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exceed the user's possible workday hours for that day."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Time Off Entry objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_off_entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1time_off_entries~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `role` (Role) - Retrieves the account role of the user associated to the time off entry, if any. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `user` (User) - Reference the user associated to the time off entry."}],"pointer":"/paths/~1time_off_entries~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_558"}},"schemaId":"schema_558","pointer":"/paths/~1time_off_entries~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/time_off_entries/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_558"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/time_off_entries/{id}","href":"time-off-entries/update time off entry","openApiOperationId":"Update Time Off Entry","summary":"Updating an existing Time Off Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_558","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_558"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Time Off Entry has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_556"}},"schemaId":"schema_556"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1time_off_entries~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_556","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_556"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/time_off_entries/{id}"},{"label":"Deleting an existing Time Off Entry","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/time-off-entries/delete time off entry","routeSlug":"/kantata/specification/time-off-entries/delete time off entry","metadata":{"seo":{"title":"Deleting an existing Time Off Entry","description":"This will delete the time off entry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Time Off Entry","name":"Deleting an existing Time Off Entry","isWebhook":false,"pointer":"/paths/~1time_off_entries~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Time Off Entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will delete the time off entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1time_off_entries~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/time_off_entries/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/time_off_entries/{id}","href":"time-off-entries/delete time off entry","openApiOperationId":"Delete Time Off Entry","summary":"Deleting an existing Time Off Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Time Off Entry has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1time_off_entries~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/time_off_entries/{id}"}],"content":{"contentType":"group","meta":{"name":"Time Off Entries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Time Off Entries","showPageActions":true},{"nodeType":"markdoc","content":"Time Off Entries represent the time and dates that a user has requested off from work, such as PTO or vacation days."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/time_off_entries","summary":"Fetching a list of Time Off Entries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/time-off-entries/get time off entries","deprecated":false},{"title":"/time_off_entries","summary":"Creating one or many Time Off Entries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/time-off-entries/create time off entry","deprecated":false},{"title":"/time_off_entries","summary":"Delete multiple time off entries","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/time-off-entries/delete time off entries","deprecated":false},{"title":"/time_off_entries/{id}","summary":"Updating an existing Time Off Entry","prefix":{"name":"put","color":"put"},"badges":[],"link":"/time-off-entries/update time off entry","deprecated":false},{"title":"/time_off_entries/{id}","summary":"Deleting an existing Time Off Entry","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/time-off-entries/delete time off entry","deprecated":false}]}]}]}]}},{"type":"group","label":"Workweek Memberships","link":"/kantata/specification/workweek-memberships","routeSlug":"/kantata/specification/workweek-memberships","items":[{"label":"Fetching a list of Workweek Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workweek-memberships/get workweek memberships","routeSlug":"/kantata/specification/workweek-memberships/get workweek memberships","metadata":{"seo":{"title":"Fetching a list of Workweek Memberships","description":"The Workweek Memberships endpoint provides a list of all workweek memberships that belongs to theaccount of the user making the request. The response will contain an array of workweek membershipobjects, sorted by their start_date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workweek Memberships","name":"Fetching a list of Workweek Memberships","isWebhook":false,"pointer":"/paths/~1workweek_memberships/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Workweek Memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Workweek Memberships endpoint provides a list of all workweek memberships that belongs to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account of the user making the request. The response will contain an array of workweek membership"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"objects, sorted by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workweek Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workweek_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"effective_date","in":"query","schemaId":"schema_368","description":"Includes only workweek memberships with a start date before, and an end date after, the specified date. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - References the user to whom the workweek membership belongs.\n- `workweek` (Workweek) - References the associated workweek."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_553","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `start_date:asc` and `start_date:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"participants_for_workspace_id","in":"query","schemaId":"schema_313","description":"Limit Workweek Memberships by those participating in the workspace of the specified workspace ID."},{"name":"participating_with","in":"query","schemaId":"schema_305","description":"Limits workweek memberships to those associated with the user making the request."},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"user_ids","in":"query","schemaId":"schema_352","description":"Includes only workweek memberships that belong to the specified user IDs."}],"pointer":"/paths/~1workweek_memberships/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workweek_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"effective_date","in":"query","schemaId":"schema_368"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_553"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"participants_for_workspace_id","in":"query","schemaId":"schema_313"},{"name":"participating_with","in":"query","required":false,"schemaId":"schema_305"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"user_ids","in":"query","schemaId":"schema_352","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workweek_memberships","href":"workweek-memberships/get workweek memberships","openApiOperationId":"Get Workweek Memberships","summary":"Fetching a list of Workweek Memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Workweek Memberships have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}},"schemaId":"schema_559"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workweek_memberships/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_559","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workweek_memberships"},{"label":"Creating a new Workweek Membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workweek-memberships/create workweek membership","routeSlug":"/kantata/specification/workweek-memberships/create workweek membership","metadata":{"seo":{"title":"Creating a new Workweek Membership","description":"This endpoint returns structured Workweek Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workweek_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workweek Membership","name":"Creating a new Workweek Membership","isWebhook":false,"pointer":"/paths/~1workweek_memberships/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Workweek Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workweek Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workweek_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - References the user to whom the workweek membership belongs.\n- `workweek` (Workweek) - References the associated workweek."}],"pointer":"/paths/~1workweek_memberships/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_560"}},"schemaId":"schema_560","pointer":"/paths/~1workweek_memberships/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workweek_memberships","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_560"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workweek_memberships","href":"workweek-memberships/create workweek membership","openApiOperationId":"Create Workweek Membership","summary":"Creating a new Workweek Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_560","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_560"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workweek Membership has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}},"schemaId":"schema_559"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workweek_memberships/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_559","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workweek_memberships"},{"label":"Switch to default workweek","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workweek-memberships/update user workweek to default","routeSlug":"/kantata/specification/workweek-memberships/update user workweek to default","metadata":{"seo":{"title":"Switch to default workweek","description":"Switches the specified user to the account default workweek, starting on the specified date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update User Workweek To Default","name":"Switch to default workweek","isWebhook":false,"pointer":"/paths/~1workweek_memberships~1standardize_to_default/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Switch to default workweek","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Switches the specified user to the account default workweek, starting on the specified date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workweek Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workweek_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - References the user to whom the workweek membership belongs.\n- `workweek` (Workweek) - References the associated workweek."}],"pointer":"/paths/~1workweek_memberships~1standardize_to_default/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_561"}},"schemaId":"schema_561","pointer":"/paths/~1workweek_memberships~1standardize_to_default/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workweek_memberships/standardize_to_default","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_561"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workweek_memberships/standardize_to_default","href":"workweek-memberships/update user workweek to default","openApiOperationId":"Update User Workweek To Default","summary":"Switch to default workweek"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_561","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_561"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workweek Membership has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}},"schemaId":"schema_559"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workweek_memberships~1standardize_to_default/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_559","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workweek_memberships/standardize_to_default"},{"label":"Fetching a single Workweek Membership","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workweek-memberships/get workweek membership","routeSlug":"/kantata/specification/workweek-memberships/get workweek membership","metadata":{"seo":{"title":"Fetching a single Workweek Membership","description":"This endpoint returns structured Workweek Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workweek_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workweek Membership","name":"Fetching a single Workweek Membership","isWebhook":false,"pointer":"/paths/~1workweek_memberships~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Workweek Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workweek Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workweek_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workweek_memberships~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - References the user to whom the workweek membership belongs.\n- `workweek` (Workweek) - References the associated workweek."}],"pointer":"/paths/~1workweek_memberships~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workweek_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workweek_memberships/{id}","href":"workweek-memberships/get workweek membership","openApiOperationId":"Get Workweek Membership","summary":"Fetching a single Workweek Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Workweek Membership has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}},"schemaId":"schema_559"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workweek_memberships~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_559","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workweek_memberships/{id}"},{"label":"Updating an existing Workweek Membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workweek-memberships/update workweek membership","routeSlug":"/kantata/specification/workweek-memberships/update workweek membership","metadata":{"seo":{"title":"Updating an existing Workweek Membership","description":"This endpoint returns structured Workweek Membership objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workweek_memberships top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workweek Membership","name":"Updating an existing Workweek Membership","isWebhook":false,"pointer":"/paths/~1workweek_memberships~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Workweek Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workweek Membership objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workweek_memberships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workweek_memberships~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `user` (User) - References the user to whom the workweek membership belongs.\n- `workweek` (Workweek) - References the associated workweek."}],"pointer":"/paths/~1workweek_memberships~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_562"}},"schemaId":"schema_562","pointer":"/paths/~1workweek_memberships~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workweek_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_562"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workweek_memberships/{id}","href":"workweek-memberships/update workweek membership","openApiOperationId":"Update Workweek Membership","summary":"Updating an existing Workweek Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_562","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_562"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workweek Membership has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}},"schemaId":"schema_559"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workweek_memberships~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_559","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workweek_memberships/{id}"},{"label":"Deleting an existing Workweek Membership","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workweek-memberships/delete workweek membership","routeSlug":"/kantata/specification/workweek-memberships/delete workweek membership","metadata":{"seo":{"title":"Deleting an existing Workweek Membership","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Workweek Membership","name":"Deleting an existing Workweek Membership","isWebhook":false,"pointer":"/paths/~1workweek_memberships~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Workweek Membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workweek_memberships~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workweek_memberships/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/workweek_memberships/{id}","href":"workweek-memberships/delete workweek membership","openApiOperationId":"Delete Workweek Membership","summary":"Deleting an existing Workweek Membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Workweek Membership has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workweek_memberships~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workweek_memberships/{id}"}],"content":{"contentType":"group","meta":{"name":"Workweek Memberships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workweek Memberships","showPageActions":true},{"nodeType":"markdoc","content":"A Workweek Membership represents the relationship of a user to a workweek."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workweek_memberships","summary":"Fetching a list of Workweek Memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workweek-memberships/get workweek memberships","deprecated":false},{"title":"/workweek_memberships","summary":"Creating a new Workweek Membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workweek-memberships/create workweek membership","deprecated":false},{"title":"/workweek_memberships/standardize_to_default","summary":"Switch to default workweek","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workweek-memberships/update user workweek to default","deprecated":false},{"title":"/workweek_memberships/{id}","summary":"Fetching a single Workweek Membership","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workweek-memberships/get workweek membership","deprecated":false},{"title":"/workweek_memberships/{id}","summary":"Updating an existing Workweek Membership","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workweek-memberships/update workweek membership","deprecated":false},{"title":"/workweek_memberships/{id}","summary":"Deleting an existing Workweek Membership","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workweek-memberships/delete workweek membership","deprecated":false}]}]}]}]}},{"type":"group","label":"Workweeks","link":"/kantata/specification/workweeks","routeSlug":"/kantata/specification/workweeks","items":[{"label":"Fetching a list of Workweeks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workweeks/get workweeks","routeSlug":"/kantata/specification/workweeks/get workweeks","metadata":{"seo":{"title":"Fetching a list of Workweeks","description":"The Workweeks endpoint provides a list of every default Workweek that belongs to the Account of the User making the request.The response will contain an array of Workweek objects, sorted by their start_date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workweeks","name":"Fetching a list of Workweeks","isWebhook":false,"pointer":"/paths/~1workweeks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Workweeks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Workweeks endpoint provides a list of every default Workweek that belongs to the Account of the User making the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain an array of Workweek objects, sorted by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workweek objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workweeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"effective_date","in":"query","schemaId":"schema_368","description":"Includes only workweeks that are effective on and after the specified date. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `workweek_memberships` (WorkweekMembership) - References the workweek memberships that use the workweek."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_553","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `start_date:asc`, and `start_date:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1workweeks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workweeks","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"effective_date","in":"query","schemaId":"schema_368"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_553"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workweeks","href":"workweeks/get workweeks","openApiOperationId":"Get Workweeks","summary":"Fetching a list of Workweeks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Workweeks have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}},"schemaId":"schema_563"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workweeks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_563","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workweeks"},{"label":"Creating a new Workweek","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workweeks/create workweek","routeSlug":"/kantata/specification/workweeks/create workweek","metadata":{"seo":{"title":"Creating a new Workweek","description":"This endpoint returns structured Workweek objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workweeks top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Workweek","name":"Creating a new Workweek","isWebhook":false,"pointer":"/paths/~1workweeks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Workweek","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workweek objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workweeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"enable_workweeks","in":"query","schemaId":"schema_305","description":"Required when creating a workweek for the first time."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `workweek_memberships` (WorkweekMembership) - References the workweek memberships that use the workweek."}],"pointer":"/paths/~1workweeks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_564"}},"schemaId":"schema_564","pointer":"/paths/~1workweeks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workweeks","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"enable_workweeks","in":"query","required":false,"schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_564"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workweeks","href":"workweeks/create workweek","openApiOperationId":"Create Workweek","summary":"Creating a new Workweek"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_564","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_564"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workweek has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}},"schemaId":"schema_563"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workweeks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_563","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workweeks"},{"label":"Fetching a single Workweek","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workweeks/get workweek","routeSlug":"/kantata/specification/workweeks/get workweek","metadata":{"seo":{"title":"Fetching a single Workweek","description":"This endpoint returns structured Workweek objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workweeks top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Workweek","name":"Fetching a single Workweek","isWebhook":false,"pointer":"/paths/~1workweeks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Workweek","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workweek objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workweeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workweeks~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `workweek_memberships` (WorkweekMembership) - References the workweek memberships that use the workweek."}],"pointer":"/paths/~1workweeks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workweeks/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workweeks/{id}","href":"workweeks/get workweek","openApiOperationId":"Get Workweek","summary":"Fetching a single Workweek"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Workweek has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}},"schemaId":"schema_563"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workweeks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_563","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workweeks/{id}"},{"label":"Updating an existing Workweek","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workweeks/update workweek","routeSlug":"/kantata/specification/workweeks/update workweek","metadata":{"seo":{"title":"Updating an existing Workweek","description":"This endpoint returns structured Workweek objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the workweeks top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Workweek","name":"Updating an existing Workweek","isWebhook":false,"pointer":"/paths/~1workweeks~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Workweek","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Workweek objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workweeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workweeks~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `workweek_memberships` (WorkweekMembership) - References the workweek memberships that use the workweek."}],"pointer":"/paths/~1workweeks~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_564"}},"schemaId":"schema_564","pointer":"/paths/~1workweeks~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workweeks/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_564"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/workweeks/{id}","href":"workweeks/update workweek","openApiOperationId":"Update Workweek","summary":"Updating an existing Workweek"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_564","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_564"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workweek has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}},"schemaId":"schema_563"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workweeks~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_563","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workweeks/{id}"},{"label":"Deleting an existing Workweek","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/workweeks/delete workweek","routeSlug":"/kantata/specification/workweeks/delete workweek","metadata":{"seo":{"title":"Deleting an existing Workweek","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Workweek","name":"Deleting an existing Workweek","isWebhook":false,"pointer":"/paths/~1workweeks~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Workweek","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1workweeks~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workweeks/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/workweeks/{id}","href":"workweeks/delete workweek","openApiOperationId":"Delete Workweek","summary":"Deleting an existing Workweek"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Workweek has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1workweeks~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/workweeks/{id}"}],"content":{"contentType":"group","meta":{"name":"Workweeks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workweeks","showPageActions":true},{"nodeType":"markdoc","content":"Workweeks in Kantata OX are owned by an Account. They can be used as the default for an Account or\ncan be associated to a User through a Workweek Membership."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workweeks","summary":"Fetching a list of Workweeks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workweeks/get workweeks","deprecated":false},{"title":"/workweeks","summary":"Creating a new Workweek","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workweeks/create workweek","deprecated":false},{"title":"/workweeks/{id}","summary":"Fetching a single Workweek","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workweeks/get workweek","deprecated":false},{"title":"/workweeks/{id}","summary":"Updating an existing Workweek","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workweeks/update workweek","deprecated":false},{"title":"/workweeks/{id}","summary":"Deleting an existing Workweek","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workweeks/delete workweek","deprecated":false}]}]}]}]}},{"type":"separator","label":"Surveys (Legacy)","content":null},{"type":"group","label":"Survey Answers (Legacy)","link":"/kantata/specification/survey-answers-(legacy)","routeSlug":"/kantata/specification/survey-answers-(legacy)","items":[{"label":"Fetching a list of Survey Answers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/survey-answers-(legacy)/get survey answers","routeSlug":"/kantata/specification/survey-answers-(legacy)/get survey answers","metadata":{"seo":{"title":"Fetching a list of Survey Answers","description":"This endpoint returns structured Survey Answer objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the survey_answers top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Survey Answers","name":"Fetching a list of Survey Answers","isWebhook":false,"pointer":"/paths/~1survey_answers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Survey Answers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Survey Answer objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"survey_answers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `choices` (SurveyQuestionChoice) - The selected choices associated with an answer. Only populated on single or multi choice answers.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `survey_question` (SurveyQuestion) - The question that the answer is directed at.\n- `survey_response` (SurveyResponse) - The response that the answer is tied to."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"survey_response_id","in":"query","schemaId":"schema_313","description":"Filter results by answers for a particular response."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1survey_answers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/survey_answers","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"survey_response_id","in":"query","schemaId":"schema_313"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/survey_answers","href":"survey-answers-(legacy)/get survey answers","openApiOperationId":"Get Survey Answers","summary":"Fetching a list of Survey Answers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Survey Answers have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_565"}},"schemaId":"schema_565"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_answers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_565","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_565"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_answers"},{"label":"Creating a new Survey Answer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/survey-answers-(legacy)/create survey answer","routeSlug":"/kantata/specification/survey-answers-(legacy)/create survey answer","metadata":{"seo":{"title":"Creating a new Survey Answer","description":"This endpoint returns structured Survey Answer objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the survey_answers top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Survey Answer","name":"Creating a new Survey Answer","isWebhook":false,"pointer":"/paths/~1survey_answers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Survey Answer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Survey Answer objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"survey_answers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `choices` (SurveyQuestionChoice) - The selected choices associated with an answer. Only populated on single or multi choice answers.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `survey_question` (SurveyQuestion) - The question that the answer is directed at.\n- `survey_response` (SurveyResponse) - The response that the answer is tied to."}],"pointer":"/paths/~1survey_answers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_566"}},"schemaId":"schema_566","pointer":"/paths/~1survey_answers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/survey_answers","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_566"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/survey_answers","href":"survey-answers-(legacy)/create survey answer","openApiOperationId":"Create Survey Answer","summary":"Creating a new Survey Answer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_566","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_566"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Survey Answer has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_565"}},"schemaId":"schema_565"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_answers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_565","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_565"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_answers"},{"label":"Updating an existing Survey Answer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/survey-answers-(legacy)/update survey answer","routeSlug":"/kantata/specification/survey-answers-(legacy)/update survey answer","metadata":{"seo":{"title":"Updating an existing Survey Answer","description":"This endpoint returns structured Survey Answer objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the survey_answers top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Survey Answer","name":"Updating an existing Survey Answer","isWebhook":false,"pointer":"/paths/~1survey_answers~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Survey Answer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Survey Answer objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"survey_answers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1survey_answers~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `choices` (SurveyQuestionChoice) - The selected choices associated with an answer. Only populated on single or multi choice answers.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `survey_question` (SurveyQuestion) - The question that the answer is directed at.\n- `survey_response` (SurveyResponse) - The response that the answer is tied to."}],"pointer":"/paths/~1survey_answers~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_567"}},"schemaId":"schema_567","pointer":"/paths/~1survey_answers~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/survey_answers/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_567"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/survey_answers/{id}","href":"survey-answers-(legacy)/update survey answer","openApiOperationId":"Update Survey Answer","summary":"Updating an existing Survey Answer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_567","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_567"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Survey Answer has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_565"}},"schemaId":"schema_565"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_answers~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_565","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_565"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_answers/{id}"},{"label":"Deleting an existing Survey Answer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/survey-answers-(legacy)/delete survey answer","routeSlug":"/kantata/specification/survey-answers-(legacy)/delete survey answer","metadata":{"seo":{"title":"Deleting an existing Survey Answer","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Survey Answer","name":"Deleting an existing Survey Answer","isWebhook":false,"pointer":"/paths/~1survey_answers~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Survey Answer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1survey_answers~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/survey_answers/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/survey_answers/{id}","href":"survey-answers-(legacy)/delete survey answer","openApiOperationId":"Delete Survey Answer","summary":"Deleting an existing Survey Answer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Survey Answer has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_answers~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_answers/{id}"}],"content":{"contentType":"group","meta":{"name":"Survey Answers (Legacy)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Survey Answers (Legacy)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Survey Answers (Legacy) appear on and can be responded to through surveys. Survey Answers (Legacy) are required to have a value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the answer (i.e. answers must have at least one choice selected or a non-null value). Additionally, only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one value type can be specified for the answer (e.g. specifying a date value as well as choice values is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invalid)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This feature requires the Surveys (Legacy) account add-on. This feature is unrelated to Pulse surveys."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/survey_answers","summary":"Fetching a list of Survey Answers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/survey-answers-(legacy)/get survey answers","deprecated":false},{"title":"/survey_answers","summary":"Creating a new Survey Answer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/survey-answers-(legacy)/create survey answer","deprecated":false},{"title":"/survey_answers/{id}","summary":"Updating an existing Survey Answer","prefix":{"name":"put","color":"put"},"badges":[],"link":"/survey-answers-(legacy)/update survey answer","deprecated":false},{"title":"/survey_answers/{id}","summary":"Deleting an existing Survey Answer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/survey-answers-(legacy)/delete survey answer","deprecated":false}]}]}]}]}},{"type":"group","label":"Survey Questions (Legacy)","link":"/kantata/specification/survey-questions-(legacy)","routeSlug":"/kantata/specification/survey-questions-(legacy)","items":[{"label":"Fetching a list of Survey Questions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/survey-questions-(legacy)/get survey questions","routeSlug":"/kantata/specification/survey-questions-(legacy)/get survey questions","metadata":{"seo":{"title":"Fetching a list of Survey Questions","description":"This endpoint returns structured Survey Question objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the survey_questions top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Survey Questions","name":"Fetching a list of Survey Questions","isWebhook":false,"pointer":"/paths/~1survey_questions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Survey Questions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Survey Question objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"survey_questions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `choices` (SurveyQuestionChoice) - The available choices associated with a question. Only populated on single or multi choice questions.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."},{"name":"included_on_template","in":"query","schemaId":"schema_313","description":"Filter results for questions included on a particular template."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."}],"pointer":"/paths/~1survey_questions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/survey_questions","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"included_on_template","in":"query","schemaId":"schema_313"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/survey_questions","href":"survey-questions-(legacy)/get survey questions","openApiOperationId":"Get Survey Questions","summary":"Fetching a list of Survey Questions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Survey Questions have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568"}},"schemaId":"schema_568"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_questions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_568","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_questions"},{"label":"Creating a new Survey Question","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/survey-questions-(legacy)/create survey question","routeSlug":"/kantata/specification/survey-questions-(legacy)/create survey question","metadata":{"seo":{"title":"Creating a new Survey Question","description":"This endpoint returns structured Survey Question objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the survey_questions top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Survey Question","name":"Creating a new Survey Question","isWebhook":false,"pointer":"/paths/~1survey_questions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Survey Question","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Survey Question objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"survey_questions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `choices` (SurveyQuestionChoice) - The available choices associated with a question. Only populated on single or multi choice questions.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."}],"pointer":"/paths/~1survey_questions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_569"}},"schemaId":"schema_569","pointer":"/paths/~1survey_questions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/survey_questions","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_569"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/survey_questions","href":"survey-questions-(legacy)/create survey question","openApiOperationId":"Create Survey Question","summary":"Creating a new Survey Question"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_569","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_569"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Survey Question has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568"}},"schemaId":"schema_568"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_questions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_568","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_questions"},{"label":"Updating an existing Survey Question","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/survey-questions-(legacy)/update survey question","routeSlug":"/kantata/specification/survey-questions-(legacy)/update survey question","metadata":{"seo":{"title":"Updating an existing Survey Question","description":"This endpoint returns structured Survey Question objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the survey_questions top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Survey Question","name":"Updating an existing Survey Question","isWebhook":false,"pointer":"/paths/~1survey_questions~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Survey Question","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Survey Question objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"survey_questions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1survey_questions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `choices` (SurveyQuestionChoice) - The available choices associated with a question. Only populated on single or multi choice questions.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object."}],"pointer":"/paths/~1survey_questions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_570"}},"schemaId":"schema_570","pointer":"/paths/~1survey_questions~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/survey_questions/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_570"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/survey_questions/{id}","href":"survey-questions-(legacy)/update survey question","openApiOperationId":"Update Survey Question","summary":"Updating an existing Survey Question"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_570","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_570"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Survey Question has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568"}},"schemaId":"schema_568"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_questions~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_568","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_questions/{id}"},{"label":"Deleting an existing Survey Question","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/survey-questions-(legacy)/delete survey question","routeSlug":"/kantata/specification/survey-questions-(legacy)/delete survey question","metadata":{"seo":{"title":"Deleting an existing Survey Question","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Survey Question","name":"Deleting an existing Survey Question","isWebhook":false,"pointer":"/paths/~1survey_questions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Survey Question","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1survey_questions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/survey_questions/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/survey_questions/{id}","href":"survey-questions-(legacy)/delete survey question","openApiOperationId":"Delete Survey Question","summary":"Deleting an existing Survey Question"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Survey Question has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_questions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_questions/{id}"}],"content":{"contentType":"group","meta":{"name":"Survey Questions (Legacy)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Survey Questions (Legacy)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Survey Questions (Legacy) appear on and can be responded to through surveys."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This feature requires the Surveys (Legacy) account add-on. This feature is unrelated to Pulse surveys."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/survey_questions","summary":"Fetching a list of Survey Questions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/survey-questions-(legacy)/get survey questions","deprecated":false},{"title":"/survey_questions","summary":"Creating a new Survey Question","prefix":{"name":"post","color":"post"},"badges":[],"link":"/survey-questions-(legacy)/create survey question","deprecated":false},{"title":"/survey_questions/{id}","summary":"Updating an existing Survey Question","prefix":{"name":"put","color":"put"},"badges":[],"link":"/survey-questions-(legacy)/update survey question","deprecated":false},{"title":"/survey_questions/{id}","summary":"Deleting an existing Survey Question","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/survey-questions-(legacy)/delete survey question","deprecated":false}]}]}]}]}},{"type":"group","label":"Survey Templates (Legacy)","link":"/kantata/specification/survey-templates-(legacy)","routeSlug":"/kantata/specification/survey-templates-(legacy)","items":[{"label":"Fetching a list of Survey Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/survey-templates-(legacy)/get survey templates","routeSlug":"/kantata/specification/survey-templates-(legacy)/get survey templates","metadata":{"seo":{"title":"Fetching a list of Survey Templates","description":"This endpoint returns structured Survey Template objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the survey_templates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Survey Templates","name":"Fetching a list of Survey Templates","isWebhook":false,"pointer":"/paths/~1survey_templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Survey Templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Survey Template objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"survey_templates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `owner` (User) - The user who owns all surveys based on this template.\n- `respondent` (User) - The user assigned to respond to surveys based on this template.\n- `subject` (polymorphic) - The subject of the survey (e.g. the user being reviewed).\n- `survey_questions` (SurveyQuestion) - Includes survey questions associated with the survey template.\n- `survey_responses` (SurveyResponse) - Includes the survey responses associated with the survey template.\n- `workspace` (Workspace) - The workspace to be used as context for surveys based on this template."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"owner_id","in":"query","schemaId":"schema_313","description":"Filter results for templates with a particular owner."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"respondent_id","in":"query","schemaId":"schema_313","description":"Filter results for templates with a particular respondent."},{"name":"subject_id","in":"query","schemaId":"schema_313","description":"Filter results for templates with a particular subject. Note: This should always be combined with the subject_type filter."},{"name":"subject_type","in":"query","schemaId":"schema_304","description":"Filter results for templates with a particular subject type."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Filter results for templates with a particular workspace."}],"pointer":"/paths/~1survey_templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/survey_templates","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"owner_id","in":"query","schemaId":"schema_313"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"respondent_id","in":"query","schemaId":"schema_313"},{"name":"subject_id","in":"query","schemaId":"schema_313"},{"name":"subject_type","in":"query","schemaId":"schema_304"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/survey_templates","href":"survey-templates-(legacy)/get survey templates","openApiOperationId":"Get Survey Templates","summary":"Fetching a list of Survey Templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Survey Templates have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_571"}},"schemaId":"schema_571"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_571","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_571"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_templates"},{"label":"Creating a new Survey Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/survey-templates-(legacy)/create survey template","routeSlug":"/kantata/specification/survey-templates-(legacy)/create survey template","metadata":{"seo":{"title":"Creating a new Survey Template","description":"This endpoint returns structured Survey Template objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the survey_templates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Survey Template","name":"Creating a new Survey Template","isWebhook":false,"pointer":"/paths/~1survey_templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Survey Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Survey Template objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"survey_templates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `owner` (User) - The user who owns all surveys based on this template.\n- `respondent` (User) - The user assigned to respond to surveys based on this template.\n- `subject` (polymorphic) - The subject of the survey (e.g. the user being reviewed).\n- `survey_questions` (SurveyQuestion) - Includes survey questions associated with the survey template.\n- `survey_responses` (SurveyResponse) - Includes the survey responses associated with the survey template.\n- `workspace` (Workspace) - The workspace to be used as context for surveys based on this template."}],"pointer":"/paths/~1survey_templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_572"}},"schemaId":"schema_572","pointer":"/paths/~1survey_templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/survey_templates","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_572"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/survey_templates","href":"survey-templates-(legacy)/create survey template","openApiOperationId":"Create Survey Template","summary":"Creating a new Survey Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_572","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_572"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Survey Template has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_571"}},"schemaId":"schema_571"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_templates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_571","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_571"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_templates"},{"label":"Updating an existing Survey Template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/survey-templates-(legacy)/update survey template","routeSlug":"/kantata/specification/survey-templates-(legacy)/update survey template","metadata":{"seo":{"title":"Updating an existing Survey Template","description":"This endpoint returns structured Survey Template objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the survey_templates top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Survey Template","name":"Updating an existing Survey Template","isWebhook":false,"pointer":"/paths/~1survey_templates~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Survey Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Survey Template objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"survey_templates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1survey_templates~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `owner` (User) - The user who owns all surveys based on this template.\n- `respondent` (User) - The user assigned to respond to surveys based on this template.\n- `subject` (polymorphic) - The subject of the survey (e.g. the user being reviewed).\n- `survey_questions` (SurveyQuestion) - Includes survey questions associated with the survey template.\n- `survey_responses` (SurveyResponse) - Includes the survey responses associated with the survey template.\n- `workspace` (Workspace) - The workspace to be used as context for surveys based on this template."}],"pointer":"/paths/~1survey_templates~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_573"}},"schemaId":"schema_573","pointer":"/paths/~1survey_templates~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/survey_templates/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_573"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/survey_templates/{id}","href":"survey-templates-(legacy)/update survey template","openApiOperationId":"Update Survey Template","summary":"Updating an existing Survey Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_573","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_573"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Survey Template has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_571"}},"schemaId":"schema_571"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_templates~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_571","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_571"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_templates/{id}"},{"label":"Deleting an existing Survey Template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/survey-templates-(legacy)/delete survey template","routeSlug":"/kantata/specification/survey-templates-(legacy)/delete survey template","metadata":{"seo":{"title":"Deleting an existing Survey Template","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Survey Template","name":"Deleting an existing Survey Template","isWebhook":false,"pointer":"/paths/~1survey_templates~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Survey Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1survey_templates~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/survey_templates/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/survey_templates/{id}","href":"survey-templates-(legacy)/delete survey template","openApiOperationId":"Delete Survey Template","summary":"Deleting an existing Survey Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Survey Template has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_templates~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_templates/{id}"}],"content":{"contentType":"group","meta":{"name":"Survey Templates (Legacy)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Survey Templates (Legacy)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Survey Templates (Legacy) define a set of questions and defaults from which Survey Responses can be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This feature requires the Surveys (Legacy) account add-on. This feature is unrelated to Pulse surveys."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/survey_templates","summary":"Fetching a list of Survey Templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/survey-templates-(legacy)/get survey templates","deprecated":false},{"title":"/survey_templates","summary":"Creating a new Survey Template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/survey-templates-(legacy)/create survey template","deprecated":false},{"title":"/survey_templates/{id}","summary":"Updating an existing Survey Template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/survey-templates-(legacy)/update survey template","deprecated":false},{"title":"/survey_templates/{id}","summary":"Deleting an existing Survey Template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/survey-templates-(legacy)/delete survey template","deprecated":false}]}]}]}]}},{"type":"group","label":"Surveys Responses (Legacy)","link":"/kantata/specification/surveys-responses-(legacy)","routeSlug":"/kantata/specification/surveys-responses-(legacy)","items":[{"label":"Fetching a list of Survey Responses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/surveys-responses-(legacy)/get survey responses","routeSlug":"/kantata/specification/surveys-responses-(legacy)/get survey responses","metadata":{"seo":{"title":"Fetching a list of Survey Responses","description":"This endpoint returns structured Survey Response objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the survey_responses top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Survey Responses","name":"Fetching a list of Survey Responses","isWebhook":false,"pointer":"/paths/~1survey_responses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Survey Responses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Survey Response objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"survey_responses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `owner` (User) - The user who owns the survey response.\n- `respondent` (User) - The user assigned to complete the survey response.\n- `subject` (polymorphic) - The subject of the survey.\n- `survey_answers` (SurveyAnswer) - The survey answers associated with the response.\n- `survey_template` (SurveyTemplate) - The template that the survey response is based on.\n- `workspace` (Workspace) - The workspace the survey is related to."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"owner_id","in":"query","schemaId":"schema_313","description":"Filter results by responses with a particular owner."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"respondent_id","in":"query","schemaId":"schema_313","description":"Filter results by responses with a particular respondent."},{"name":"status","in":"query","schemaId":"schema_304","description":"Filter results by responses with a particular status."},{"name":"subject_id","in":"query","schemaId":"schema_313","description":"Filter results by responses with a particular subject id. Note: This should always be combined with the subject_type filter."},{"name":"subject_type","in":"query","schemaId":"schema_304","description":"Filter results by responses with a particular subject type."},{"name":"survey_template_id","in":"query","schemaId":"schema_313","description":"Filter results by responses that were created from a particular survey template."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Filter results by responses for a particular workspace."}],"pointer":"/paths/~1survey_responses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/survey_responses","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"owner_id","in":"query","schemaId":"schema_313"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"respondent_id","in":"query","schemaId":"schema_313"},{"name":"status","in":"query","schemaId":"schema_304"},{"name":"subject_id","in":"query","schemaId":"schema_313"},{"name":"subject_type","in":"query","schemaId":"schema_304"},{"name":"survey_template_id","in":"query","schemaId":"schema_313"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/survey_responses","href":"surveys-responses-(legacy)/get survey responses","openApiOperationId":"Get Survey Responses","summary":"Fetching a list of Survey Responses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Survey Responses have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}},"schemaId":"schema_574"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_responses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_574","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_responses"},{"label":"Creating a new Survey Response","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/surveys-responses-(legacy)/create survey response","routeSlug":"/kantata/specification/surveys-responses-(legacy)/create survey response","metadata":{"seo":{"title":"Creating a new Survey Response","description":"This endpoint returns structured Survey Response objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the survey_responses top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Survey Response","name":"Creating a new Survey Response","isWebhook":false,"pointer":"/paths/~1survey_responses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Survey Response","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Survey Response objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"survey_responses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `owner` (User) - The user who owns the survey response.\n- `respondent` (User) - The user assigned to complete the survey response.\n- `subject` (polymorphic) - The subject of the survey.\n- `survey_answers` (SurveyAnswer) - The survey answers associated with the response.\n- `survey_template` (SurveyTemplate) - The template that the survey response is based on.\n- `workspace` (Workspace) - The workspace the survey is related to."}],"pointer":"/paths/~1survey_responses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_575"}},"schemaId":"schema_575","pointer":"/paths/~1survey_responses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/survey_responses","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_575"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/survey_responses","href":"surveys-responses-(legacy)/create survey response","openApiOperationId":"Create Survey Response","summary":"Creating a new Survey Response"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_575"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Survey Response has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}},"schemaId":"schema_574"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_responses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_574","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_responses"},{"label":"Updating an existing Survey Response","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/surveys-responses-(legacy)/update survey response","routeSlug":"/kantata/specification/surveys-responses-(legacy)/update survey response","metadata":{"seo":{"title":"Updating an existing Survey Response","description":"This endpoint returns structured Survey Response objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the survey_responses top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Survey Response","name":"Updating an existing Survey Response","isWebhook":false,"pointer":"/paths/~1survey_responses~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Survey Response","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Survey Response objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"survey_responses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1survey_responses~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `owner` (User) - The user who owns the survey response.\n- `respondent` (User) - The user assigned to complete the survey response.\n- `subject` (polymorphic) - The subject of the survey.\n- `survey_answers` (SurveyAnswer) - The survey answers associated with the response.\n- `survey_template` (SurveyTemplate) - The template that the survey response is based on.\n- `workspace` (Workspace) - The workspace the survey is related to."}],"pointer":"/paths/~1survey_responses~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_576"}},"schemaId":"schema_576","pointer":"/paths/~1survey_responses~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/survey_responses/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_576"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/survey_responses/{id}","href":"surveys-responses-(legacy)/update survey response","openApiOperationId":"Update Survey Response","summary":"Updating an existing Survey Response"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_576","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_576"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Survey Response has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}},"schemaId":"schema_574"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_responses~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_574","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_responses/{id}"},{"label":"Deleting an existing Survey Response","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/surveys-responses-(legacy)/delete survey response","routeSlug":"/kantata/specification/surveys-responses-(legacy)/delete survey response","metadata":{"seo":{"title":"Deleting an existing Survey Response","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Survey Response","name":"Deleting an existing Survey Response","isWebhook":false,"pointer":"/paths/~1survey_responses~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Survey Response","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1survey_responses~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/survey_responses/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/survey_responses/{id}","href":"surveys-responses-(legacy)/delete survey response","openApiOperationId":"Delete Survey Response","summary":"Deleting an existing Survey Response"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Survey Response has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1survey_responses~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/survey_responses/{id}"}],"content":{"contentType":"group","meta":{"name":"Surveys Responses (Legacy)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Surveys Responses (Legacy)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Survey Response (Legacy) represents an instance of a particular survey that has been assigned for response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This feature requires the Surveys (Legacy) account add-on. This feature is unrelated to Pulse surveys."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/survey_responses","summary":"Fetching a list of Survey Responses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/surveys-responses-(legacy)/get survey responses","deprecated":false},{"title":"/survey_responses","summary":"Creating a new Survey Response","prefix":{"name":"post","color":"post"},"badges":[],"link":"/surveys-responses-(legacy)/create survey response","deprecated":false},{"title":"/survey_responses/{id}","summary":"Updating an existing Survey Response","prefix":{"name":"put","color":"put"},"badges":[],"link":"/surveys-responses-(legacy)/update survey response","deprecated":false},{"title":"/survey_responses/{id}","summary":"Deleting an existing Survey Response","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/surveys-responses-(legacy)/delete survey response","deprecated":false}]}]}]}]}},{"type":"separator","label":"Tasks","content":null},{"type":"group","label":"Assignments","link":"/kantata/specification/assignments","routeSlug":"/kantata/specification/assignments","items":[{"label":"Fetching a list of Assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/assignments/get assignments","routeSlug":"/kantata/specification/assignments/get assignments","metadata":{"seo":{"title":"Fetching a list of Assignments","description":"For Account Administrators, returns task assignments in all projects across an account.For non-Account Administrators, returns task assignments only in projects they are part of."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Assignments","name":"Fetching a list of Assignments","isWebhook":false,"pointer":"/paths/~1assignments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Assignments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Account Administrators, returns task assignments in all projects across an account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-Account Administrators, returns task assignments only in projects they are part of."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Assignment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"assignee_id","in":"query","schemaId":"schema_313","description":"Only includes assignments that belong to the specified user ID."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"current","in":"query","schemaId":"schema_305","description":"Only includes assignments that are active."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"in_unarchived_stories","in":"query","schemaId":"schema_321","description":"Only includes assignments that belong to inactive tasks.\n(Inactive tasks can exist in active projects, and vice versa.)."},{"name":"in_unarchived_workspaces","in":"query","schemaId":"schema_321","description":"Only includes assignments that belong to active projects."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `assignee` (User) - Retrieves the user assigned to the task. The response will include `assignee_id`, which references the data in the `users` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `story` (Story) - Retrieves the task. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `story_allocation_days` (StoryAllocationDay) - Retrieves the Story Allocation Days (i.e. Daily Scheduled Hours) for the resource assigned to the task. When using this\nvalue, the `plannable` filter must be set to `true`. To retrieve story allocation days for unnamed resources, also set\nthe `include_unnamed` filter to `true`. The response will include `story_allocation_day_ids`, which references the data\nin the `story_allocation_days` top-level key."},{"name":"include_unnamed","in":"query","schemaId":"schema_351","description":"Includes task assignments to unnamed resources. Think of unnamed resources as placeholders;\n it indicates the need for a certain role, before knowing who will fill it. Set to `False` by default."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_307","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"plannable","in":"query","schemaId":"schema_305","description":"Filters for assignments which the requester can view and create\n [Daily Scheduled Hours](/tag/Daily-Scheduled-Hours-(Story-Allocation-Days)) for. Must be set to `true` when using the `include` parameter with the `story_allocation_days` association."},{"name":"resource_id","in":"query","schemaId":"schema_313","description":"Only includes assignments that belong to the specified resource ID."},{"name":"story_id","in":"query","schemaId":"schema_313","description":"Only includes assignments that belong to the specified task ID."},{"name":"uncurrent","in":"query","schemaId":"schema_305","description":"Only includes assignments that are inactive."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Only includes assignments that belong to the specified project ID."}],"pointer":"/paths/~1assignments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/assignments","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"assignee_id","in":"query","schemaId":"schema_313"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"current","in":"query","schemaId":"schema_305"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"in_unarchived_stories","in":"query","schemaId":"schema_321"},{"name":"in_unarchived_workspaces","in":"query","schemaId":"schema_321"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"include_unnamed","in":"query","required":false,"schemaId":"schema_351"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_307"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"plannable","in":"query","required":false,"schemaId":"schema_305"},{"name":"resource_id","in":"query","schemaId":"schema_313"},{"name":"story_id","in":"query","schemaId":"schema_313"},{"name":"uncurrent","in":"query","schemaId":"schema_305"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/assignments","href":"assignments/get assignments","openApiOperationId":"Get Assignments","summary":"Fetching a list of Assignments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Assignments have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}},"schemaId":"schema_577"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1assignments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_577","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/assignments"},{"label":"Creating a new Assignment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/assignments/create assignment","routeSlug":"/kantata/specification/assignments/create assignment","metadata":{"seo":{"title":"Creating a new Assignment","description":"This endpoint returns structured Assignment objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the assignments top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Assignment","name":"Creating a new Assignment","isWebhook":false,"pointer":"/paths/~1assignments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Assignment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `assignee` (User) - Retrieves the user assigned to the task. The response will include `assignee_id`, which references the data in the `users` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `story` (Story) - Retrieves the task. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `story_allocation_days` (StoryAllocationDay) - Retrieves the Story Allocation Days (i.e. Daily Scheduled Hours) for the resource assigned to the task. When using this\nvalue, the `plannable` filter must be set to `true`. To retrieve story allocation days for unnamed resources, also set\nthe `include_unnamed` filter to `true`. The response will include `story_allocation_day_ids`, which references the data\nin the `story_allocation_days` top-level key."}],"pointer":"/paths/~1assignments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_578"}},"schemaId":"schema_578","pointer":"/paths/~1assignments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/assignments","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_578"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/assignments","href":"assignments/create assignment","openApiOperationId":"Create Assignment","summary":"Creating a new Assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_578","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_578"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Assignment has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}},"schemaId":"schema_577"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1assignments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_577","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/assignments"},{"label":"Fetching a single Assignment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/assignments/get assignment","routeSlug":"/kantata/specification/assignments/get assignment","metadata":{"seo":{"title":"Fetching a single Assignment","description":"This endpoint returns structured Assignment objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the assignments top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Assignment","name":"Fetching a single Assignment","isWebhook":false,"pointer":"/paths/~1assignments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Assignment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1assignments~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `assignee` (User) - Retrieves the user assigned to the task. The response will include `assignee_id`, which references the data in the `users` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `story` (Story) - Retrieves the task. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `story_allocation_days` (StoryAllocationDay) - Retrieves the Story Allocation Days (i.e. Daily Scheduled Hours) for the resource assigned to the task. When using this\nvalue, the `plannable` filter must be set to `true`. To retrieve story allocation days for unnamed resources, also set\nthe `include_unnamed` filter to `true`. The response will include `story_allocation_day_ids`, which references the data\nin the `story_allocation_days` top-level key."}],"pointer":"/paths/~1assignments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/assignments/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/assignments/{id}","href":"assignments/get assignment","openApiOperationId":"Get Assignment","summary":"Fetching a single Assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Assignment has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}},"schemaId":"schema_577"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1assignments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_577","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/assignments/{id}"},{"label":"Updating an existing Assignment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/assignments/update assignment","routeSlug":"/kantata/specification/assignments/update assignment","metadata":{"seo":{"title":"Updating an existing Assignment","description":"This endpoint returns structured Assignment objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the assignments top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Assignment","name":"Updating an existing Assignment","isWebhook":false,"pointer":"/paths/~1assignments~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Assignment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1assignments~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `assignee` (User) - Retrieves the user assigned to the task. The response will include `assignee_id`, which references the data in the `users` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `story` (Story) - Retrieves the task. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `story_allocation_days` (StoryAllocationDay) - Retrieves the Story Allocation Days (i.e. Daily Scheduled Hours) for the resource assigned to the task. When using this\nvalue, the `plannable` filter must be set to `true`. To retrieve story allocation days for unnamed resources, also set\nthe `include_unnamed` filter to `true`. The response will include `story_allocation_day_ids`, which references the data\nin the `story_allocation_days` top-level key."}],"pointer":"/paths/~1assignments~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_579"}},"schemaId":"schema_579","pointer":"/paths/~1assignments~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/assignments/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_579"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/assignments/{id}","href":"assignments/update assignment","openApiOperationId":"Update Assignment","summary":"Updating an existing Assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_579","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_579"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Assignment has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}},"schemaId":"schema_577"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1assignments~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_577","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/assignments/{id}"},{"label":"Deleting an existing Assignment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/assignments/delete assignment","routeSlug":"/kantata/specification/assignments/delete assignment","metadata":{"seo":{"title":"Deleting an existing Assignment","description":"Unassigns a resource from a task. The assignment is soft deleted bysetting the current field to false. The assignment is thenconsidered inactive. Using this endpoint is the same as usingthe update an existing assignmentendpoint and setting the current parameter to false."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Assignment","name":"Deleting an existing Assignment","isWebhook":false,"pointer":"/paths/~1assignments~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unassigns a resource from a task. The assignment is soft deleted by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"setting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The assignment is then"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"considered inactive. Using this endpoint is the same as using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Assignments#operation/update-assignment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update an existing assignment"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint and setting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1assignments~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/assignments/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/assignments/{id}","href":"assignments/delete assignment","openApiOperationId":"Delete Assignment","summary":"Deleting an existing Assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Assignment has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1assignments~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/assignments/{id}"}],"content":{"contentType":"group","meta":{"name":"Assignments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assignments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Assignments object allows you to view and manage task assignments for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"named or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/115004696493#Unnamed"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unnamed resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Because"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Daily-Scheduled-Hours-(Story-Allocation-Days)"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily Scheduled Hours"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are a part of Assignments, they can be affected when an assignment changes."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/assignments","summary":"Fetching a list of Assignments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assignments/get assignments","deprecated":false},{"title":"/assignments","summary":"Creating a new Assignment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assignments/create assignment","deprecated":false},{"title":"/assignments/{id}","summary":"Fetching a single Assignment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assignments/get assignment","deprecated":false},{"title":"/assignments/{id}","summary":"Updating an existing Assignment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/assignments/update assignment","deprecated":false},{"title":"/assignments/{id}","summary":"Deleting an existing Assignment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/assignments/delete assignment","deprecated":false}]}]}]}]}},{"type":"group","label":"Daily Scheduled Hours (Story Allocation Days)","link":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)","routeSlug":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)","items":[{"label":"Fetching a list of Daily Scheduled Hours (Story Allocation Days)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)/get story allocation days","routeSlug":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)/get story allocation days","metadata":{"seo":{"title":"Fetching a list of Daily Scheduled Hours (Story Allocation Days)","description":"Returns all Daily Scheduled Hours that are visible to the requester,based on permissions. Filter results by specific projects, users, tasks, and more."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Story Allocation Days","name":"Fetching a list of Daily Scheduled Hours (Story Allocation Days)","isWebhook":false,"pointer":"/paths/~1story_allocation_days/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Daily Scheduled Hours (Story Allocation Days)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all Daily Scheduled Hours that are visible to the requester,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"based on permissions. Filter results by specific projects, users, tasks, and more."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTES"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes Daily Scheduled Hours that are part of inactive Assignments, by default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To filter these out, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are an Account Administrator, you can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"only_my_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to filter for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily Scheduled Hours from only your account. This optimizes performance of the endpoint."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The returned Daily Scheduled Hours are sorted by when they were last updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Daily Scheduled Hours (Story Allocation Day) objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"story_allocation_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"assignee_id","in":"query","schemaId":"schema_313","description":"Returns Daily Scheduled Hours that are assigned to the User of the specified ID."},{"name":"assignment_id","in":"query","schemaId":"schema_313","description":"Returns Daily Scheduled Hours that belong to the Assignment of the specified ID."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"current","in":"query","schemaId":"schema_305","description":"Returns Daily Scheduled Hours that belong to active Assignments."},{"name":"date_between","in":"query","schemaId":"schema_304","description":"Requires a colon separated pair of dates in YYYY-MM-DD format. Results are inclusive of the endpoints. If a date is not passed in, it is interpreted as negative or positive infinity."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"in_unarchived_stories","in":"query","schemaId":"schema_321","description":"Returns Daily Scheduled Hours that belong to active (not archived) Stories."},{"name":"in_unarchived_workspaces","in":"query","schemaId":"schema_321","description":"Returns Daily Scheduled Hours that belong to active (not archived) Workspaces."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `assignment` (Assignment) - Reference the Assignment of the Story Allocation Day.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `story` (Story) - Reference the Story of the Story Allocation Day.\n- `workspace` (Workspace) - Reference the Workspace of the Story Allocation Day."},{"name":"include_unnamed","in":"query","schemaId":"schema_351","description":"Includes Daily Scheduled Hours from Assignments with\n[unnamed resources](https://mavenlink.zendesk.com/hc/en-us/articles/115004696493#Unnamed).\nThink of unnamed resources as placeholders; it indicates the need for a certain role,\nbefore knowing who will fill it.\n\nSet to `False` by default."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"only_my_account","in":"query","schemaId":"schema_351","description":"If you are an Account Administrator, you can set this to `True` in order to filter\nfor Daily Scheduled Hours from only your account.\n\nEnabling this filter optimizes performance of the endpoint.\nThe filter is set to `False` by default."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `date:asc`, `date:desc`, `id:asc`, `id:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"story_id","in":"query","schemaId":"schema_313","description":"Returns Daily Scheduled Hours that belong to the Story of the specified ID."},{"name":"uncurrent","in":"query","schemaId":"schema_305","description":"Returns Daily Scheduled Hours that belong to inactive Assignments."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_at_between","in":"query","schemaId":"schema_304","description":"Requires a colon separated pair of timestamps. Timestamps are in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) with colons removed. Results are inclusive of the endpoints. If a timestamp is not passed in, it is interpreted as negative or positive infinity."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Returns Daily Scheduled Hours that belong to the Workspace of the specified ID."}],"pointer":"/paths/~1story_allocation_days/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/story_allocation_days","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"assignee_id","in":"query","schemaId":"schema_313"},{"name":"assignment_id","in":"query","schemaId":"schema_313"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"current","in":"query","schemaId":"schema_305"},{"name":"date_between","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"in_unarchived_stories","in":"query","schemaId":"schema_321"},{"name":"in_unarchived_workspaces","in":"query","schemaId":"schema_321"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"include_unnamed","in":"query","required":false,"schemaId":"schema_351"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"only_my_account","in":"query","required":false,"schemaId":"schema_351"},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"story_id","in":"query","schemaId":"schema_313"},{"name":"uncurrent","in":"query","schemaId":"schema_305"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_at_between","in":"query","schemaId":"schema_304"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/story_allocation_days","href":"daily-scheduled-hours-(story-allocation-days)/get story allocation days","openApiOperationId":"Get Story Allocation Days","summary":"Fetching a list of Daily Scheduled Hours (Story Allocation Days)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Daily Scheduled Hours (Story Allocation Day)s have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_580"}},"schemaId":"schema_580"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_allocation_days/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_580","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_580"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_allocation_days"},{"label":"Creating a new Daily Scheduled Hours (Story Allocation Day)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)/create story allocation day","routeSlug":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)/create story allocation day","metadata":{"seo":{"title":"Creating a new Daily Scheduled Hours (Story Allocation Day)","description":"This endpoint returns structured Daily Scheduled Hours (Story Allocation Day) objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the story_allocation_days top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Story Allocation Day","name":"Creating a new Daily Scheduled Hours (Story Allocation Day)","isWebhook":false,"pointer":"/paths/~1story_allocation_days/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Daily Scheduled Hours (Story Allocation Day)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Daily Scheduled Hours (Story Allocation Day) objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"story_allocation_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `assignment` (Assignment) - Reference the Assignment of the Story Allocation Day.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `story` (Story) - Reference the Story of the Story Allocation Day.\n- `workspace` (Workspace) - Reference the Workspace of the Story Allocation Day."}],"pointer":"/paths/~1story_allocation_days/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_581"}},"schemaId":"schema_581","pointer":"/paths/~1story_allocation_days/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/story_allocation_days","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_581"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/story_allocation_days","href":"daily-scheduled-hours-(story-allocation-days)/create story allocation day","openApiOperationId":"Create Story Allocation Day","summary":"Creating a new Daily Scheduled Hours (Story Allocation Day)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_581","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_581"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Daily Scheduled Hours (Story Allocation Day) has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_580"}},"schemaId":"schema_580"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_allocation_days/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_580","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_580"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_allocation_days"},{"label":"Delete multiple Daily Scheduled Hours (Story Allocation Days)","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)/delete story allocation days","routeSlug":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)/delete story allocation days","metadata":{"seo":{"title":"Delete multiple Daily Scheduled Hours (Story Allocation Days)","description":"The IDs of the Daily Scheduled Hours to delete can be provided in the ids query parameter orvia the request body. Only daily scheduled hours on your account can be deleted.Request body example:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Story Allocation Days","name":"Delete multiple Daily Scheduled Hours (Story Allocation Days)","isWebhook":false,"pointer":"/paths/~1story_allocation_days/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete multiple Daily Scheduled Hours (Story Allocation Days)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs of the Daily Scheduled Hours to delete can be provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via the request body. Only daily scheduled hours on your account can be deleted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" \"ids\": \"1,2,3\"\n}```\nIf any specified Daily Scheduled Hours cannot be deleted, the entire request will fail and an error message\nwill be returned that specifies which ones could not be deleted and why.\n\n\nThis endpoint returns structured Daily Scheduled Hours (Story Allocation Day) objects.\nAs with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array\nand will be indexed by ID in the `story_allocation_days` top-level JSON key.\nPlease see our [Response Format](#section/Response-Format) section for more information.","language":"{"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" \"ids\": \"1,2,3\"\n}```\nIf any specified Daily Scheduled Hours cannot be deleted, the entire request will fail and an error message\nwill be returned that specifies which ones could not be deleted and why.\n\n\nThis endpoint returns structured Daily Scheduled Hours (Story Allocation Day) objects.\nAs with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array\nand will be indexed by ID in the `story_allocation_days` top-level JSON key.\nPlease see our [Response Format](#section/Response-Format) section for more information."},"children":[]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ids","in":"query","schemaId":"schema_304","description":"A comma-separated list of IDs of Daily Scheduled Hours. You can provide up to 100 IDs. The IDs can be\nprovided in this query parameter or via the request body."}],"pointer":"/paths/~1story_allocation_days/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/story_allocation_days","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"ids","in":"query","required":false,"schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/story_allocation_days","href":"daily-scheduled-hours-(story-allocation-days)/delete story allocation days","openApiOperationId":"Delete Story Allocation Days","summary":"Delete multiple Daily Scheduled Hours (Story Allocation Days)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Daily Scheduled Hours (Story Allocation Day) has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_allocation_days/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_allocation_days"},{"label":"Fetching a single Daily Scheduled Hours (Story Allocation Day)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)/get story allocation day","routeSlug":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)/get story allocation day","metadata":{"seo":{"title":"Fetching a single Daily Scheduled Hours (Story Allocation Day)","description":"This endpoint returns structured Daily Scheduled Hours (Story Allocation Day) objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the story_allocation_days top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Story Allocation Day","name":"Fetching a single Daily Scheduled Hours (Story Allocation Day)","isWebhook":false,"pointer":"/paths/~1story_allocation_days~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Daily Scheduled Hours (Story Allocation Day)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Daily Scheduled Hours (Story Allocation Day) objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"story_allocation_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1story_allocation_days~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `assignment` (Assignment) - Reference the Assignment of the Story Allocation Day.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `story` (Story) - Reference the Story of the Story Allocation Day.\n- `workspace` (Workspace) - Reference the Workspace of the Story Allocation Day."}],"pointer":"/paths/~1story_allocation_days~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/story_allocation_days/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/story_allocation_days/{id}","href":"daily-scheduled-hours-(story-allocation-days)/get story allocation day","openApiOperationId":"Get Story Allocation Day","summary":"Fetching a single Daily Scheduled Hours (Story Allocation Day)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Daily Scheduled Hours (Story Allocation Day) has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_580"}},"schemaId":"schema_580"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_allocation_days~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_580","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_580"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_allocation_days/{id}"},{"label":"Updating an existing Daily Scheduled Hours (Story Allocation Day)","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)/update story allocation day","routeSlug":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)/update story allocation day","metadata":{"seo":{"title":"Updating an existing Daily Scheduled Hours (Story Allocation Day)","description":"This endpoint returns structured Daily Scheduled Hours (Story Allocation Day) objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the story_allocation_days top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Story Allocation Day","name":"Updating an existing Daily Scheduled Hours (Story Allocation Day)","isWebhook":false,"pointer":"/paths/~1story_allocation_days~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Daily Scheduled Hours (Story Allocation Day)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Daily Scheduled Hours (Story Allocation Day) objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"story_allocation_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1story_allocation_days~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `assignment` (Assignment) - Reference the Assignment of the Story Allocation Day.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `story` (Story) - Reference the Story of the Story Allocation Day.\n- `workspace` (Workspace) - Reference the Workspace of the Story Allocation Day."}],"pointer":"/paths/~1story_allocation_days~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_582"}},"schemaId":"schema_582","pointer":"/paths/~1story_allocation_days~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/story_allocation_days/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_582"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/story_allocation_days/{id}","href":"daily-scheduled-hours-(story-allocation-days)/update story allocation day","openApiOperationId":"Update Story Allocation Day","summary":"Updating an existing Daily Scheduled Hours (Story Allocation Day)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_582","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_582"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Daily Scheduled Hours (Story Allocation Day) has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_580"}},"schemaId":"schema_580"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_allocation_days~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_580","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_580"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_allocation_days/{id}"},{"label":"Deleting an existing Daily Scheduled Hours (Story Allocation Day)","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)/delete story allocation day","routeSlug":"/kantata/specification/daily-scheduled-hours-(story-allocation-days)/delete story allocation day","metadata":{"seo":{"title":"Deleting an existing Daily Scheduled Hours (Story Allocation Day)","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Story Allocation Day","name":"Deleting an existing Daily Scheduled Hours (Story Allocation Day)","isWebhook":false,"pointer":"/paths/~1story_allocation_days~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Daily Scheduled Hours (Story Allocation Day)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1story_allocation_days~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/story_allocation_days/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/story_allocation_days/{id}","href":"daily-scheduled-hours-(story-allocation-days)/delete story allocation day","openApiOperationId":"Delete Story Allocation Day","summary":"Deleting an existing Daily Scheduled Hours (Story Allocation Day)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Daily Scheduled Hours (Story Allocation Day) has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_allocation_days~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_allocation_days/{id}"}],"content":{"contentType":"group","meta":{"name":"Daily Scheduled Hours (Story Allocation Days)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Daily Scheduled Hours (Story Allocation Days)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily Scheduled Hours (also called Story Allocation Days) is the allocation of time for a resource to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"spend on a specific task, on a specific day."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily Scheduled Hours are part of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Assignments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assignments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"so if an Assignment is deleted, so are its Daily Scheduled Hours."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/story_allocation_days","summary":"Fetching a list of Daily Scheduled Hours (Story Allocation Days)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/daily-scheduled-hours-(story-allocation-days)/get story allocation days","deprecated":false},{"title":"/story_allocation_days","summary":"Creating a new Daily Scheduled Hours (Story Allocation Day)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/daily-scheduled-hours-(story-allocation-days)/create story allocation day","deprecated":false},{"title":"/story_allocation_days","summary":"Delete multiple Daily Scheduled Hours (Story Allocation Days)","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/daily-scheduled-hours-(story-allocation-days)/delete story allocation days","deprecated":false},{"title":"/story_allocation_days/{id}","summary":"Fetching a single Daily Scheduled Hours (Story Allocation Day)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/daily-scheduled-hours-(story-allocation-days)/get story allocation day","deprecated":false},{"title":"/story_allocation_days/{id}","summary":"Updating an existing Daily Scheduled Hours (Story Allocation Day)","prefix":{"name":"put","color":"put"},"badges":[],"link":"/daily-scheduled-hours-(story-allocation-days)/update story allocation day","deprecated":false},{"title":"/story_allocation_days/{id}","summary":"Deleting an existing Daily Scheduled Hours (Story Allocation Day)","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/daily-scheduled-hours-(story-allocation-days)/delete story allocation day","deprecated":false}]}]}]}]}},{"type":"group","label":"Followers","link":"/kantata/specification/followers","routeSlug":"/kantata/specification/followers","items":[{"label":"Fetching a list of Story Follows","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/followers/get story follows","routeSlug":"/kantata/specification/followers/get story follows","metadata":{"seo":{"title":"Fetching a list of Story Follows","description":"By default, you will get all story follows that you are permitted to see. If you are an Administrator, you will see every story follow on your account. Otherwise you will see every story follow in projects in which you are participating."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Story Follows","name":"Fetching a list of Story Follows","isWebhook":false,"pointer":"/paths/~1story_follows/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Story Follows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"By default, you will get all story follows that you are permitted to see. If you are an Administrator,\nyou will see every story follow on your account. Otherwise you will see every story follow in projects\nin which you are participating."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/story_follows","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["400","401","403","404","422","503"],"pointer":"/story_follows","href":"followers/get story follows","openApiOperationId":"Get Story Follows","summary":"Fetching a list of Story Follows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_follows/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_follows"},{"label":"Following a story","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/followers/create story follow","routeSlug":"/kantata/specification/followers/create story follow","metadata":{"seo":{"title":"Following a story","description":"Following a story"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Story Follow","name":"Following a story","isWebhook":false,"pointer":"/paths/~1story_follows/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Following a story","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_583"}},"schemaId":"schema_583","pointer":"/paths/~1story_follows/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/story_follows","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_583"}},"responseCodes":["400","401","403","404","422","503"],"pointer":"/story_follows","href":"followers/create story follow","openApiOperationId":"Create Story Follow","summary":"Following a story"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_583","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_583"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_follows/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_follows"},{"label":"Retrieving a single Story Follow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/followers/get story follow","routeSlug":"/kantata/specification/followers/get story follow","metadata":{"seo":{"title":"Retrieving a single Story Follow","description":"Retrieving a single Story Follow"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Story Follow","name":"Retrieving a single Story Follow","isWebhook":false,"pointer":"/paths/~1story_follows~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieving a single Story Follow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1story_follows~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/story_follows/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["400","401","403","404","422","503"],"pointer":"/story_follows/{id}","href":"followers/get story follow","openApiOperationId":"Get Story Follow","summary":"Retrieving a single Story Follow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_follows~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_follows/{id}"},{"label":"Unfollowing a story","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/followers/delete story follow","routeSlug":"/kantata/specification/followers/delete story follow","metadata":{"seo":{"title":"Unfollowing a story","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Story Follow","name":"Unfollowing a story","isWebhook":false,"pointer":"/paths/~1story_follows~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unfollowing a story","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1story_follows~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/story_follows/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/story_follows/{id}","href":"followers/delete story follow","openApiOperationId":"Delete Story Follow","summary":"Unfollowing a story"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Follower has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_follows~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_follows/{id}"}],"content":{"contentType":"group","meta":{"name":"Followers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Followers","showPageActions":true},{"nodeType":"markdoc","content":"Story Follows allow users to follow a task to which they are not assigned."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/story_follows","summary":"Fetching a list of Story Follows","prefix":{"name":"get","color":"get"},"badges":[],"link":"/followers/get story follows","deprecated":false},{"title":"/story_follows","summary":"Following a story","prefix":{"name":"post","color":"post"},"badges":[],"link":"/followers/create story follow","deprecated":false},{"title":"/story_follows/{id}","summary":"Retrieving a single Story Follow","prefix":{"name":"get","color":"get"},"badges":[],"link":"/followers/get story follow","deprecated":false},{"title":"/story_follows/{id}","summary":"Unfollowing a story","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/followers/delete story follow","deprecated":false}]}]}]}]}},{"type":"group","label":"Stories","link":"/kantata/specification/stories","routeSlug":"/kantata/specification/stories","items":[{"label":"Fetching a list of Stories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/stories/get stories","routeSlug":"/kantata/specification/stories/get stories","metadata":{"seo":{"title":"Fetching a list of Stories","description":"This endpoint returns structured Story objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the stories top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Stories","name":"Fetching a list of Stories","isWebhook":false,"pointer":"/paths/~1stories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Stories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Story objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"active_between","in":"query","schemaId":"schema_304","description":"Filter for tasks that have a start or due date that is within a specified date range. Specify the date range with\n a pair of colon-separated dates, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example, `2013-06-01:2013-08-01`."},{"name":"all_on_account","in":"query","schemaId":"schema_305","description":"If you are a reports viewer or administrator, you can retrieve all stories on an account."},{"name":"archived","in":"query","schemaId":"schema_304","description":"Include, filter for, _or_ exclude archived tasks (e.g. `GET https://api.mavenlink.com/api/v1/stories?archived=exclude`).\n Valid values: `include`, `only`, `exclude`."},{"name":"assigned_to_current_user","in":"query","schemaId":"schema_305","description":"If set to `true`, includes tasks that are assigned to the user making the request."},{"name":"by_any_tag","in":"query","schemaId":"schema_304","description":"Include tasks with at least 1 of the specified [tags](https://mavenlink.zendesk.com/hc/en-us/articles/360052128794-New-Task-Tracker#Task-Rows).\n Give multiple tags in a comma-separated list (e.g. `GET /api/v1/stories.json?by_tag_name=design,product management,writing`).\n Tags (and therefore valid values for tags) are defined by users."},{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field choice value, represented as a string with the custom field ID, followed by a\ncolon, and then comma-separated custom field choice value IDs. The custom field choice value can also be\nthe word `blank`. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\n\nThe following formats are supported:\n\n- `custom_field_ID:choice_value_ID`\n- `custom_field_ID:choice_value_1_ID,choice_value_2_ID`\n- `custom_field_ID:blank`\n- `(custom_field_1_ID:choice_value_1_ID,choice_value_2_ID):(custom_field_2_ID:choice_value_3_ID)`."},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field currency value, represented as a string with the custom field ID, followed by a\ncolon, and then the currency value. Optionally, the currency [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473) can be supplied as well, separated\nfrom the currency value by another colon. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200.2:USD):(2:100)`."},{"name":"by_custom_date_field","in":"query","schemaId":"schema_304","description":"Filter for tasks with custom fields that have a date value within a specified range.\nSpecify the custom field ID and date range in a colon-separated string, with dates in a YYYY-MM-DD format.\nFor example, `GET /api/v1/stories.json?by_custom_date_field=18290:2018-05-02:2018-06-01`.\n\nGive multiple custom fields with date values in a semicolon-separated list\n(e.g. `GET /api/v1/stories.json?by_custom_date_field=18290:2018-05-02:2018-06-01;18291:2018-06-15:2018-08-15`)."},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field date value, represented as a string with the custom field ID, followed by a\ncolon, the starting date, another colon, and then the ending date. You can provide both a starting date\nand ending date, or provide just one. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:2014-12-05:2014-12-25):(2:2014-12-05)`."},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field number value, represented as a string with the custom field ID, followed by a\ncolon, and then the number value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:200):(2:101)`."},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304","description":"Filter by a custom field text value, represented as a string with the custom field ID, followed by a\ncolon, and then the text value. Multiple custom fields can be delimited by semicolons or by parentheses and colons.\nThe following formats are supported:\n\n- `(1:something):(2:else)`\n- `(1:something):(1:else)` (multiple values for the same field, returns objects matching any value)\n- `1` (bare field ID with no value, returns all objects that have any value for that field)."},{"name":"by_status","in":"query","schemaId":"schema_304","description":"Filter by task status. Provide a comma-separated list of task status names."},{"name":"by_subtask_count","in":"query","schemaId":"schema_313","description":"Filters for parent tasks with the specified number of subtasks."},{"name":"by_tag_name","in":"query","schemaId":"schema_304","description":"Include tasks with the exact [tags](https://mavenlink.zendesk.com/hc/en-us/articles/360052128794-New-Task-Tracker#Task-Rows) specified.\n Give multiple tags in a comma-separated list (e.g. `GET /api/v1/stories.json?by_tag_name=development,data analysis`).\n Tags (and therefore valid values for tags) are defined by users."},{"name":"by_workspace_group","in":"query","schemaId":"schema_304","description":"Filter for tasks in projects that belong to a [Project Group](/tag/Workspace-Groups) (ID).\n Give multiple project group IDs in a comma-separated list."},{"name":"completed","in":"query","schemaId":"schema_305","description":"Filter for only completed tasks. If `false`, no filtering is applied."},{"name":"completed_between","in":"query","schemaId":"schema_304","description":"Filter for tasks that were completed within the specified date range. Specify the date range with\n a pair of colon-separated dates, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example, `2013-06-01:2013-08-01`."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"creators","in":"query","schemaId":"schema_304","description":"Filter for tasks created by the specified user (ID).\n Give multiple user IDs in a comma-separated list (e.g. `GET https://api.mavenlink.com/api/v1/stories?creators=1,2,3`)."},{"name":"due_after","in":"query","schemaId":"schema_368","description":"Filter for tasks that are due after the specified date. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"due_before","in":"query","schemaId":"schema_368","description":"Filter for tasks that are due before the specified date. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"due_between","in":"query","schemaId":"schema_304","description":"Filter for tasks with a due date that is within a specified date range. Specify the date range with\n a pair of colon-separated dates, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example, `2013-06-01:2013-08-01`."},{"name":"due_on","in":"query","schemaId":"schema_368","description":"Filter for tasks that are due on the specified date. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"exclude_workspace_title_from_search","in":"query","schemaId":"schema_305","description":"If set to `true`, excludes tasks in projects with a title that matches searched text."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304","description":"Filter by the presence of a custom field value for the specified comma-separated custom field ID(s)."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `ancestors` (Story) - Retrieves all of the tasks that the task is nested under (parents and top-level tasks). The response will include `ancestor_ids`, which references the data in the `stories` top-level key.\n- `assigned_role` (Role) - Retrieves the authenticated user’s assigned role for the task. The response will include `assigned_role_id`, which references the data in the `roles` top-level key.\n- `assignees` (User) - Retrieves all users assigned to the task, excluding unnamed resources. The response will include `assignee_ids`, which references the data in the `users` top-level key.\n- `attachments` (Attachments::PostAttachment) - Retrieves all attachments in the task's posts. The response will include `attachment_ids`, which references the data in the `attachments` top-level key. Must be used with the `only` parameter.\n- `creator` (User) - Retrieves the user who created the task. The response will include `creator_id`, which references the data in the `users` top-level key.\n- `current_assignments` (Assignment) - Retrieves all assignments for the task. The response will include `current_assignment_ids`, which references the data in the `assignments` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the task’s custom field values. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `descendants` (Story) - Retrieves all of the subtasks nested under this top-level task. The response will include `descendant_ids`, which references the data in the `stories` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `followers` (User) - Retrieves all users following the task. The response will include `follower_ids`, which references the data in the `users` top-level key.\n- `google_documents` (GoogleDocument) - Retrieves all Google documents for the task. The response will include `google_document_ids`, which references the data in the `google_documents` top-level key. Must be used with the `only` parameter.\n- `parent` (Story) - Retrieves the parent task that this subtask is nested directly under. The response will include `parent_id`, which references the data in the `stories` top-level key.\n- `potential_workspace_resources` (WorkspaceResource) - Retrieves the project's named resources who are not assigned to the task. The response will include `potential_workspace_resource_ids`, which references the data in the `workspace_resources` top-level key. Must be used with the `only` parameter.\n- `potential_workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves all of the project's resources (named and unnamed) who are not assigned to the task. The response will include `potential_workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key. Must be used with the `only` parameter.\n- `replies` (Post) - Retrieves all task posts, except for the first one. The response will include `reply_ids`, which references the data in the `posts` top-level key. Must be used with the `only` parameter.\n- `root` (Story) - Retrieves the top-level task that this subtask is nested under. The response will include `root_id`, which references the data in the `stories` top-level key.\n- `source_dependencies` (StoryDependency) - Retrieves all tasks that this task is dependent on. The response will include `source_dependency_ids`, which references the data in the `story_dependencies` top-level key.\n- `story_state_changes` (StoryStateChange) - Retrieves all status changes the task has gone through. The response will include `story_state_change_ids`, which references the data in the `story_state_changes` top-level key. Must be used with the `only` parameter.\n- `story_tasks` (StoryTask) - Retrieves all checklist items for the task. The response will include `story_task_ids`, which references the data in the `story_tasks` top-level key.\n- `sub_stories` (Story) - Retrieves all direct subtasks of the task. This does not include the subtasks of its direct subtasks. The response will include `sub_story_ids`, which references the data in the `stories` top-level key.\n- `tags` (ActsAsTaggableOn::Tag) - Retrieves all tags for the task. The response will include `tag_ids`, which references the data in the `tags` top-level key.\n- `target_dependencies` (StoryDependency) - Retrieves all tasks that are dependent on this task. The response will include `target_dependency_ids`, which references the data in the `story_dependencies` top-level key.\n- `workspace` (Workspace) - Retrieves the project the task is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources who are assigned to the task. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves all of the resources (named and unnamed) assigned to the task. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"not_assigned_to_resource","in":"query","schemaId":"schema_313","description":"Filter for tasks not assigned to the specified resource (ID)."},{"name":"not_assigned_to_user","in":"query","schemaId":"schema_313","description":"Filter for tasks not assigned to the specified user (ID)."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"only_archived","in":"query","schemaId":"schema_305","description":"If set to `true`, filters for archived tasks."},{"name":"only_deleted","in":"query","schemaId":"schema_305","description":"If set to `true`, filters for deleted tasks."},{"name":"only_todos","in":"query","schemaId":"schema_305","description":"If set to `true`, filters for only To Dos."},{"name":"optional_fields","in":"query","schemaId":"schema_584","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `due_date:asc`, `due_date:desc`, `importance`, `parent_and_position`, `position`, `priority_level:asc`, `priority_level:desc`, `start_date:asc`, `start_date:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"parents_only","in":"query","schemaId":"schema_305","description":"Filter for top-level tasks. This does not include subtasks that have other subtasks nested under them."},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"priority","in":"query","schemaId":"schema_304","description":"Filter for tasks with the specified priorities. Give multiple priorities in a comma-separated list\n (`GET https://api.mavenlink.com/api/v1/stories?priority=critical,high`).\n Valid values: `critical`, `high`, `normal`, `low`."},{"name":"search","in":"query","schemaId":"schema_304"},{"name":"show_archived","in":"query","schemaId":"schema_351","description":"If set to `true`, includes archived tasks in the response."},{"name":"show_deleted","in":"query","schemaId":"schema_351","description":"If set to `true`, includes deleted tasks."},{"name":"show_from_archived_workspaces","in":"query","schemaId":"schema_351","description":"If set to `true`, filters for tasks in archived projects."},{"name":"show_todos","in":"query","schemaId":"schema_351","description":"If set to `true`, includes To Dos in the response."},{"name":"starting_between","in":"query","schemaId":"schema_304","description":"Filter for tasks with a start date that is within a specified date range. Specify the date range with\n a pair of colon-separated dates, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example, `2013-06-01:2013-08-01`."},{"name":"story_type","in":"query","schemaId":"schema_304","description":"Include tasks of the specified type. Valid values: `task`, `milestone`, `deliverable`, `issue`."},{"name":"story_types","in":"query","schemaId":"schema_304","description":"Filter for tasks of the specified type(s). Give multiple task types in a comma-separated list."},{"name":"time_trackable_on_workspace_id","in":"query","schemaId":"schema_313","description":"Filter for tasks that [time can be tracked against](https://mavenlink.zendesk.com/hc/en-us/articles/360008143214)\n in the specified project (ID)."},{"name":"uncompleted","in":"query","schemaId":"schema_305","description":"Filter for only incomplete tasks. If `false`, no filtering is applied."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"with_ancestry_depth","in":"query","schemaId":"schema_313","description":"Include [subtasks](https://mavenlink.zendesk.com/hc/en-us/articles/205221350)\n that are nested at the specified level from the top-level task (e.g. `GET /api/v1/stories.json?with_ancestry_depth=3`).\n The top-level task is considered to be at the 0 level. Subtasks can be nested up to 4 levels from the top-level task."},{"name":"with_assignees","in":"query","schemaId":"schema_304","description":"Filter for tasks assigned to the specified users. Give multiple user IDs in a comma-separated list\n(e.g. `GET https://api.mavenlink.com/api/v1/stories?with_assignees=1,2,3`).\n\nIn addition to user IDs, you can also pass `unassigned` and `unnamed`.\nThese can be included in a comma-separated list\n(e.g. `GET https://api.mavenlink.com/api/v1/stories?with_assignees=1,2,3,unassigned,unnamed`).\n`unassigned` returns tasks that are not assigned to any users.\n`unnamed` returns tasks assigned to unnamed resources."},{"name":"with_followers","in":"query","schemaId":"schema_304","description":"Filter for tasks with the specified followers. Give multiple user IDs in a comma-separated list."},{"name":"with_parent_id","in":"query","schemaId":"schema_313","description":"Filter for [subtasks](https://mavenlink.zendesk.com/hc/en-us/articles/205221350) that are directly nested under\n the specified task (ID)."},{"name":"with_projects","in":"query","schemaId":"schema_304","description":"Include tasks in the specified projects. Give multiple project IDs in a comma-separated list."},{"name":"with_root_id","in":"query","schemaId":"schema_313","description":"Filter for [subtasks](https://mavenlink.zendesk.com/hc/en-us/articles/205221350)\n that are nested at any level under the specified task (ID)."},{"name":"with_start_or_due_date","in":"query","schemaId":"schema_304","description":"Filter for tasks with start or due dates."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"without_past_completed","in":"query","schemaId":"schema_305","description":"If set to `true`, filters for tasks that haven't previously been marked as completed."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Filter for tasks from the specified project (ID)."}],"pointer":"/paths/~1stories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stories","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"active_between","in":"query","schemaId":"schema_304"},{"name":"all_on_account","in":"query","required":false,"schemaId":"schema_305"},{"name":"archived","in":"query","schemaId":"schema_304"},{"name":"assigned_to_current_user","in":"query","schemaId":"schema_305"},{"name":"by_any_tag","in":"query","schemaId":"schema_304"},{"name":"by_custom_choice_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_currency_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_date_field","in":"query","schemaId":"schema_304"},{"name":"by_custom_date_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_number_value","in":"query","schemaId":"schema_304"},{"name":"by_custom_text_value","in":"query","schemaId":"schema_304"},{"name":"by_status","in":"query","schemaId":"schema_304"},{"name":"by_subtask_count","in":"query","schemaId":"schema_313"},{"name":"by_tag_name","in":"query","schemaId":"schema_304"},{"name":"by_workspace_group","in":"query","schemaId":"schema_304"},{"name":"completed","in":"query","schemaId":"schema_305"},{"name":"completed_between","in":"query","schemaId":"schema_304"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"creators","in":"query","schemaId":"schema_304"},{"name":"due_after","in":"query","schemaId":"schema_368"},{"name":"due_before","in":"query","schemaId":"schema_368"},{"name":"due_between","in":"query","schemaId":"schema_304"},{"name":"due_on","in":"query","schemaId":"schema_368"},{"name":"exclude_workspace_title_from_search","in":"query","schemaId":"schema_305"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"has_value_for_custom_field_ids","in":"query","schemaId":"schema_304"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"not_assigned_to_resource","in":"query","schemaId":"schema_313"},{"name":"not_assigned_to_user","in":"query","schemaId":"schema_313"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"only_archived","in":"query","schemaId":"schema_305"},{"name":"only_deleted","in":"query","schemaId":"schema_305"},{"name":"only_todos","in":"query","schemaId":"schema_305"},{"name":"optional_fields","in":"query","schemaId":"schema_584","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"parents_only","in":"query","schemaId":"schema_305"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"priority","in":"query","schemaId":"schema_304"},{"name":"search","in":"query","schemaId":"schema_304"},{"name":"show_archived","in":"query","schemaId":"schema_351"},{"name":"show_deleted","in":"query","schemaId":"schema_351"},{"name":"show_from_archived_workspaces","in":"query","schemaId":"schema_351"},{"name":"show_todos","in":"query","schemaId":"schema_351"},{"name":"starting_between","in":"query","schemaId":"schema_304"},{"name":"story_type","in":"query","schemaId":"schema_304"},{"name":"story_types","in":"query","schemaId":"schema_304"},{"name":"time_trackable_on_workspace_id","in":"query","schemaId":"schema_313"},{"name":"uncompleted","in":"query","schemaId":"schema_305"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"with_ancestry_depth","in":"query","schemaId":"schema_313"},{"name":"with_assignees","in":"query","schemaId":"schema_304"},{"name":"with_followers","in":"query","schemaId":"schema_304"},{"name":"with_parent_id","in":"query","schemaId":"schema_313"},{"name":"with_projects","in":"query","schemaId":"schema_304"},{"name":"with_root_id","in":"query","schemaId":"schema_313"},{"name":"with_start_or_due_date","in":"query","schemaId":"schema_304"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"without_past_completed","in":"query","schemaId":"schema_305"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/stories","href":"stories/get stories","openApiOperationId":"Get Stories","summary":"Fetching a list of Stories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Stories have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_585"}},"schemaId":"schema_585"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1stories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_585","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_585"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/stories"},{"label":"Creating a new Story","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/stories/create story","routeSlug":"/kantata/specification/stories/create story","metadata":{"seo":{"title":"Creating a new Story","description":"Creates a task (story) in a project (workspace)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Story","name":"Creating a new Story","isWebhook":false,"pointer":"/paths/~1stories/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Story","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a task (story) in a project (workspace)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 300 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"stories\": [\n {\n \"workspace_id\": 123,\n \"title\": \"Task\"\n },\n {\n \"workspace_id\": 456,\n \"title\": \"Task 2\"\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"stories\": [\n {\n \"workspace_id\": 123,\n \"title\": \"Task\"\n },\n {\n \"workspace_id\": 456,\n \"title\": \"Task 2\"\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Story objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `ancestors` (Story) - Retrieves all of the tasks that the task is nested under (parents and top-level tasks). The response will include `ancestor_ids`, which references the data in the `stories` top-level key.\n- `assigned_role` (Role) - Retrieves the authenticated user’s assigned role for the task. The response will include `assigned_role_id`, which references the data in the `roles` top-level key.\n- `assignees` (User) - Retrieves all users assigned to the task, excluding unnamed resources. The response will include `assignee_ids`, which references the data in the `users` top-level key.\n- `attachments` (Attachments::PostAttachment) - Retrieves all attachments in the task's posts. The response will include `attachment_ids`, which references the data in the `attachments` top-level key. Must be used with the `only` parameter.\n- `creator` (User) - Retrieves the user who created the task. The response will include `creator_id`, which references the data in the `users` top-level key.\n- `current_assignments` (Assignment) - Retrieves all assignments for the task. The response will include `current_assignment_ids`, which references the data in the `assignments` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the task’s custom field values. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `descendants` (Story) - Retrieves all of the subtasks nested under this top-level task. The response will include `descendant_ids`, which references the data in the `stories` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `followers` (User) - Retrieves all users following the task. The response will include `follower_ids`, which references the data in the `users` top-level key.\n- `google_documents` (GoogleDocument) - Retrieves all Google documents for the task. The response will include `google_document_ids`, which references the data in the `google_documents` top-level key. Must be used with the `only` parameter.\n- `parent` (Story) - Retrieves the parent task that this subtask is nested directly under. The response will include `parent_id`, which references the data in the `stories` top-level key.\n- `potential_workspace_resources` (WorkspaceResource) - Retrieves the project's named resources who are not assigned to the task. The response will include `potential_workspace_resource_ids`, which references the data in the `workspace_resources` top-level key. Must be used with the `only` parameter.\n- `potential_workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves all of the project's resources (named and unnamed) who are not assigned to the task. The response will include `potential_workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key. Must be used with the `only` parameter.\n- `replies` (Post) - Retrieves all task posts, except for the first one. The response will include `reply_ids`, which references the data in the `posts` top-level key. Must be used with the `only` parameter.\n- `root` (Story) - Retrieves the top-level task that this subtask is nested under. The response will include `root_id`, which references the data in the `stories` top-level key.\n- `source_dependencies` (StoryDependency) - Retrieves all tasks that this task is dependent on. The response will include `source_dependency_ids`, which references the data in the `story_dependencies` top-level key.\n- `story_state_changes` (StoryStateChange) - Retrieves all status changes the task has gone through. The response will include `story_state_change_ids`, which references the data in the `story_state_changes` top-level key. Must be used with the `only` parameter.\n- `story_tasks` (StoryTask) - Retrieves all checklist items for the task. The response will include `story_task_ids`, which references the data in the `story_tasks` top-level key.\n- `sub_stories` (Story) - Retrieves all direct subtasks of the task. This does not include the subtasks of its direct subtasks. The response will include `sub_story_ids`, which references the data in the `stories` top-level key.\n- `tags` (ActsAsTaggableOn::Tag) - Retrieves all tags for the task. The response will include `tag_ids`, which references the data in the `tags` top-level key.\n- `target_dependencies` (StoryDependency) - Retrieves all tasks that are dependent on this task. The response will include `target_dependency_ids`, which references the data in the `story_dependencies` top-level key.\n- `workspace` (Workspace) - Retrieves the project the task is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources who are assigned to the task. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves all of the resources (named and unnamed) assigned to the task. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_584","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1stories/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_586"}},"schemaId":"schema_586","pointer":"/paths/~1stories/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stories","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_584","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_586"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/stories","href":"stories/create story","openApiOperationId":"Create Story","summary":"Creating a new Story"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_586","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_586"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Story has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_585"}},"schemaId":"schema_585"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1stories/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_585","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_585"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/stories"},{"label":"Fetching a single Story","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/stories/get story","routeSlug":"/kantata/specification/stories/get story","metadata":{"seo":{"title":"Fetching a single Story","description":"This endpoint returns structured Story objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the stories top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Story","name":"Fetching a single Story","isWebhook":false,"pointer":"/paths/~1stories~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Story","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Story objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1stories~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `ancestors` (Story) - Retrieves all of the tasks that the task is nested under (parents and top-level tasks). The response will include `ancestor_ids`, which references the data in the `stories` top-level key.\n- `assigned_role` (Role) - Retrieves the authenticated user’s assigned role for the task. The response will include `assigned_role_id`, which references the data in the `roles` top-level key.\n- `assignees` (User) - Retrieves all users assigned to the task, excluding unnamed resources. The response will include `assignee_ids`, which references the data in the `users` top-level key.\n- `attachments` (Attachments::PostAttachment) - Retrieves all attachments in the task's posts. The response will include `attachment_ids`, which references the data in the `attachments` top-level key. Must be used with the `only` parameter.\n- `creator` (User) - Retrieves the user who created the task. The response will include `creator_id`, which references the data in the `users` top-level key.\n- `current_assignments` (Assignment) - Retrieves all assignments for the task. The response will include `current_assignment_ids`, which references the data in the `assignments` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the task’s custom field values. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `descendants` (Story) - Retrieves all of the subtasks nested under this top-level task. The response will include `descendant_ids`, which references the data in the `stories` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `followers` (User) - Retrieves all users following the task. The response will include `follower_ids`, which references the data in the `users` top-level key.\n- `google_documents` (GoogleDocument) - Retrieves all Google documents for the task. The response will include `google_document_ids`, which references the data in the `google_documents` top-level key. Must be used with the `only` parameter.\n- `parent` (Story) - Retrieves the parent task that this subtask is nested directly under. The response will include `parent_id`, which references the data in the `stories` top-level key.\n- `potential_workspace_resources` (WorkspaceResource) - Retrieves the project's named resources who are not assigned to the task. The response will include `potential_workspace_resource_ids`, which references the data in the `workspace_resources` top-level key. Must be used with the `only` parameter.\n- `potential_workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves all of the project's resources (named and unnamed) who are not assigned to the task. The response will include `potential_workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key. Must be used with the `only` parameter.\n- `replies` (Post) - Retrieves all task posts, except for the first one. The response will include `reply_ids`, which references the data in the `posts` top-level key. Must be used with the `only` parameter.\n- `root` (Story) - Retrieves the top-level task that this subtask is nested under. The response will include `root_id`, which references the data in the `stories` top-level key.\n- `source_dependencies` (StoryDependency) - Retrieves all tasks that this task is dependent on. The response will include `source_dependency_ids`, which references the data in the `story_dependencies` top-level key.\n- `story_state_changes` (StoryStateChange) - Retrieves all status changes the task has gone through. The response will include `story_state_change_ids`, which references the data in the `story_state_changes` top-level key. Must be used with the `only` parameter.\n- `story_tasks` (StoryTask) - Retrieves all checklist items for the task. The response will include `story_task_ids`, which references the data in the `story_tasks` top-level key.\n- `sub_stories` (Story) - Retrieves all direct subtasks of the task. This does not include the subtasks of its direct subtasks. The response will include `sub_story_ids`, which references the data in the `stories` top-level key.\n- `tags` (ActsAsTaggableOn::Tag) - Retrieves all tags for the task. The response will include `tag_ids`, which references the data in the `tags` top-level key.\n- `target_dependencies` (StoryDependency) - Retrieves all tasks that are dependent on this task. The response will include `target_dependency_ids`, which references the data in the `story_dependencies` top-level key.\n- `workspace` (Workspace) - Retrieves the project the task is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources who are assigned to the task. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves all of the resources (named and unnamed) assigned to the task. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_584","description":"Allows you to request one or more optional fields as an array."},{"name":"show_deleted","in":"query","schemaId":"schema_351","description":"Returns a deleted story when set to true."}],"pointer":"/paths/~1stories~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stories/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_584","style":"form","explode":false},{"name":"show_deleted","in":"query","required":false,"schemaId":"schema_351"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/stories/{id}","href":"stories/get story","openApiOperationId":"Get Story","summary":"Fetching a single Story"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Story has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_585"}},"schemaId":"schema_585"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1stories~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_585","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_585"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/stories/{id}"},{"label":"Updating an existing Story","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/stories/update story","routeSlug":"/kantata/specification/stories/update story","metadata":{"seo":{"title":"Updating an existing Story","description":"This endpoint returns structured Story objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the stories top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Story","name":"Updating an existing Story","isWebhook":false,"pointer":"/paths/~1stories~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Story","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Story objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1stories~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `ancestors` (Story) - Retrieves all of the tasks that the task is nested under (parents and top-level tasks). The response will include `ancestor_ids`, which references the data in the `stories` top-level key.\n- `assigned_role` (Role) - Retrieves the authenticated user’s assigned role for the task. The response will include `assigned_role_id`, which references the data in the `roles` top-level key.\n- `assignees` (User) - Retrieves all users assigned to the task, excluding unnamed resources. The response will include `assignee_ids`, which references the data in the `users` top-level key.\n- `attachments` (Attachments::PostAttachment) - Retrieves all attachments in the task's posts. The response will include `attachment_ids`, which references the data in the `attachments` top-level key. Must be used with the `only` parameter.\n- `creator` (User) - Retrieves the user who created the task. The response will include `creator_id`, which references the data in the `users` top-level key.\n- `current_assignments` (Assignment) - Retrieves all assignments for the task. The response will include `current_assignment_ids`, which references the data in the `assignments` top-level key.\n- `custom_field_values` (CustomFieldValue) - Retrieves the task’s custom field values. The response will include `custom_field_value_ids`, which references the data in the `custom_field_values` top-level key.\n- `descendants` (Story) - Retrieves all of the subtasks nested under this top-level task. The response will include `descendant_ids`, which references the data in the `stories` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `followers` (User) - Retrieves all users following the task. The response will include `follower_ids`, which references the data in the `users` top-level key.\n- `google_documents` (GoogleDocument) - Retrieves all Google documents for the task. The response will include `google_document_ids`, which references the data in the `google_documents` top-level key. Must be used with the `only` parameter.\n- `parent` (Story) - Retrieves the parent task that this subtask is nested directly under. The response will include `parent_id`, which references the data in the `stories` top-level key.\n- `potential_workspace_resources` (WorkspaceResource) - Retrieves the project's named resources who are not assigned to the task. The response will include `potential_workspace_resource_ids`, which references the data in the `workspace_resources` top-level key. Must be used with the `only` parameter.\n- `potential_workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves all of the project's resources (named and unnamed) who are not assigned to the task. The response will include `potential_workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key. Must be used with the `only` parameter.\n- `replies` (Post) - Retrieves all task posts, except for the first one. The response will include `reply_ids`, which references the data in the `posts` top-level key. Must be used with the `only` parameter.\n- `root` (Story) - Retrieves the top-level task that this subtask is nested under. The response will include `root_id`, which references the data in the `stories` top-level key.\n- `source_dependencies` (StoryDependency) - Retrieves all tasks that this task is dependent on. The response will include `source_dependency_ids`, which references the data in the `story_dependencies` top-level key.\n- `story_state_changes` (StoryStateChange) - Retrieves all status changes the task has gone through. The response will include `story_state_change_ids`, which references the data in the `story_state_changes` top-level key. Must be used with the `only` parameter.\n- `story_tasks` (StoryTask) - Retrieves all checklist items for the task. The response will include `story_task_ids`, which references the data in the `story_tasks` top-level key.\n- `sub_stories` (Story) - Retrieves all direct subtasks of the task. This does not include the subtasks of its direct subtasks. The response will include `sub_story_ids`, which references the data in the `stories` top-level key.\n- `tags` (ActsAsTaggableOn::Tag) - Retrieves all tags for the task. The response will include `tag_ids`, which references the data in the `tags` top-level key.\n- `target_dependencies` (StoryDependency) - Retrieves all tasks that are dependent on this task. The response will include `target_dependency_ids`, which references the data in the `story_dependencies` top-level key.\n- `workspace` (Workspace) - Retrieves the project the task is in. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.\n- `workspace_resources` (WorkspaceResource) - Retrieves the named resources who are assigned to the task. The response will include `workspace_resource_ids`, which references the data in the `workspace_resources` top-level key.\n- `workspace_resources_with_unnamed` (WorkspaceResource) - Retrieves all of the resources (named and unnamed) assigned to the task. The response will include `workspace_resources_with_unnamed_ids`, which references the data in the `workspace_resources` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_584","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1stories~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_587"}},"schemaId":"schema_587","pointer":"/paths/~1stories~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/stories/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_584","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_587"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/stories/{id}","href":"stories/update story","openApiOperationId":"Update Story","summary":"Updating an existing Story"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_587","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_587"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Story has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_585"}},"schemaId":"schema_585"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1stories~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_585","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_585"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/stories/{id}"},{"label":"Deleting an existing Story","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/stories/delete story","routeSlug":"/kantata/specification/stories/delete story","metadata":{"seo":{"title":"Deleting an existing Story","description":"Soft deletes a task (by setting a value for deleted_at). You can view soft deleted tasks by fetching alist of tasks with the only_deleted filter set to true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Story","name":"Deleting an existing Story","isWebhook":false,"pointer":"/paths/~1stories~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Story","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Soft deletes a task (by setting a value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleted_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You can view soft deleted tasks by fetching a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of tasks with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"only_deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Tasks are only permanently deleted when the project is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1stories~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/stories/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/stories/{id}","href":"stories/delete story","openApiOperationId":"Delete Story","summary":"Deleting an existing Story"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Story has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1stories~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/stories/{id}"}],"content":{"contentType":"group","meta":{"name":"Stories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stories","showPageActions":true},{"nodeType":"markdoc","content":"Stories are tasks, milestones, deliverables, or issues in\nKantata OX. They belong to Workspaces, show up in the local and\nglobal task trackers, can be linked to Posts, can have sub-Stories\nand TaskLists, and have many attributes for planning, tasking, and\nfinancials."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/stories","summary":"Fetching a list of Stories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stories/get stories","deprecated":false},{"title":"/stories","summary":"Creating a new Story","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stories/create story","deprecated":false},{"title":"/stories/{id}","summary":"Fetching a single Story","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stories/get story","deprecated":false},{"title":"/stories/{id}","summary":"Updating an existing Story","prefix":{"name":"put","color":"put"},"badges":[],"link":"/stories/update story","deprecated":false},{"title":"/stories/{id}","summary":"Deleting an existing Story","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/stories/delete story","deprecated":false}]}]}]}]}},{"type":"group","label":"Story Dependencies","link":"/kantata/specification/story-dependencies","routeSlug":"/kantata/specification/story-dependencies","items":[{"label":"Fetching a list of Story Dependencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/story-dependencies/get story dependencies","routeSlug":"/kantata/specification/story-dependencies/get story dependencies","metadata":{"seo":{"title":"Fetching a list of Story Dependencies","description":"This endpoint returns structured Story Dependency objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the story_dependencies top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Story Dependencies","name":"Fetching a list of Story Dependencies","isWebhook":false,"pointer":"/paths/~1story_dependencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Story Dependencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Story Dependency objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"story_dependencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `source` (Story) - The tasks that are predecessor tasks.\n- `target` (Story) - The tasks that are successor tasks."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_391","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `updated_at:asc` and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"show_archived","in":"query","schemaId":"schema_351","description":"If set to `true`, includes in the response dependencies where the target is an archived task."},{"name":"show_deleted","in":"query","schemaId":"schema_351","description":"If set to `true`, includes in the response dependencies where the target is an deleted task."},{"name":"show_from_archived_workspaces","in":"query","schemaId":"schema_351","description":"If set to `true`, includes in the response dependencies where the tasks belong to archived projects."},{"name":"source_id","in":"query","schemaId":"schema_313","description":"Filter for dependencies where this task is the predecessor, i.e. the task that controls the start or end date for all related successor tasks."},{"name":"target_id","in":"query","schemaId":"schema_313","description":"Filter for dependencies where this task is the successor, i.e. the task whose start or end date is controlled by a predecessor."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Filter for dependencies where the tasks belong to a specific project."}],"pointer":"/paths/~1story_dependencies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/story_dependencies","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_391"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"show_archived","in":"query","schemaId":"schema_351"},{"name":"show_deleted","in":"query","schemaId":"schema_351"},{"name":"show_from_archived_workspaces","in":"query","schemaId":"schema_351"},{"name":"source_id","in":"query","schemaId":"schema_313"},{"name":"target_id","in":"query","schemaId":"schema_313"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"workspace_id","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/story_dependencies","href":"story-dependencies/get story dependencies","openApiOperationId":"Get Story Dependencies","summary":"Fetching a list of Story Dependencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Story Dependencies have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_588"}},"schemaId":"schema_588"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_dependencies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_588","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_588"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_dependencies"},{"label":"Fetching a single Story Dependency","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/story-dependencies/get story dependency","routeSlug":"/kantata/specification/story-dependencies/get story dependency","metadata":{"seo":{"title":"Fetching a single Story Dependency","description":"This endpoint returns structured Story Dependency objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the story_dependencies top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Story Dependency","name":"Fetching a single Story Dependency","isWebhook":false,"pointer":"/paths/~1story_dependencies~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Story Dependency","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Story Dependency objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"story_dependencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1story_dependencies~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `source` (Story) - The tasks that are predecessor tasks.\n- `target` (Story) - The tasks that are successor tasks."}],"pointer":"/paths/~1story_dependencies~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/story_dependencies/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/story_dependencies/{id}","href":"story-dependencies/get story dependency","openApiOperationId":"Get Story Dependency","summary":"Fetching a single Story Dependency"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Story Dependency has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_588"}},"schemaId":"schema_588"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_dependencies~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_588","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_588"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_dependencies/{id}"}],"content":{"contentType":"group","meta":{"name":"Story Dependencies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Story Dependencies","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Story dependencies define relationships between tasks and the sequence in which they must be completed in order to close a project. A dependency is between two tasks (stories) in a project (workspace), with one being the predecessor (source) task, and the other the successor (target) task. Each relationship is characterized by the type of dependency and lag between tasks. There are four (4) types of dependencies:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finish to Start (FS)—The predecessor ends before the successor can begin."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start to Start (SS)—The predecessor begins before the successor can begin."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finish to Finish (FF)—The predecessor ends before the successor can end."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start to Finish (SF)—The predecessor begins before the successor can end."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lag is the number of days between the predecessor task ending and the successor task beginning."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To learn more about dependencies, see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://mavenlink.zendesk.com/hc/en-us/articles/360000456874-Gantt-Chart-Dependencies"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gantt Chart Dependencies article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/story_dependencies","summary":"Fetching a list of Story Dependencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/story-dependencies/get story dependencies","deprecated":false},{"title":"/story_dependencies/{id}","summary":"Fetching a single Story Dependency","prefix":{"name":"get","color":"get"},"badges":[],"link":"/story-dependencies/get story dependency","deprecated":false}]}]}]}]}},{"type":"group","label":"Story State Changes","link":"/kantata/specification/story-state-changes","routeSlug":"/kantata/specification/story-state-changes","items":[{"label":"Fetching a list of Story State Changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/story-state-changes/get story state changes","routeSlug":"/kantata/specification/story-state-changes/get story state changes","metadata":{"seo":{"title":"Fetching a list of Story State Changes","description":"The story state changes endpoint provides a list of state changes for a specified story. story_id is arequired parameter to retrieve story state changes for a specified story."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Story State Changes","name":"Fetching a list of Story State Changes","isWebhook":false,"pointer":"/paths/~1story_state_changes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Story State Changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The story state changes endpoint provides a list of state changes for a specified story. story_id is a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required parameter to retrieve story state changes for a specified story."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Story State Change objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"story_state_changes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `story` (Story) - Will reference the Story for which the story state change belongs.\n- `user` (User) - Will reference the User for which the story state change belongs."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_335","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc` and `created_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1story_state_changes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/story_state_changes","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_335"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/story_state_changes","href":"story-state-changes/get story state changes","openApiOperationId":"Get Story State Changes","summary":"Fetching a list of Story State Changes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Story State Changes have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_589"}},"schemaId":"schema_589"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_state_changes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_589","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_589"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_state_changes"},{"label":"Fetching a single Story State Change","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/story-state-changes/get story state change","routeSlug":"/kantata/specification/story-state-changes/get story state change","metadata":{"seo":{"title":"Fetching a single Story State Change","description":"This endpoint returns structured Story State Change objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the story_state_changes top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Story State Change","name":"Fetching a single Story State Change","isWebhook":false,"pointer":"/paths/~1story_state_changes~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Story State Change","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Story State Change objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"story_state_changes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1story_state_changes~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `story` (Story) - Will reference the Story for which the story state change belongs.\n- `user` (User) - Will reference the User for which the story state change belongs."}],"pointer":"/paths/~1story_state_changes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/story_state_changes/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/story_state_changes/{id}","href":"story-state-changes/get story state change","openApiOperationId":"Get Story State Change","summary":"Fetching a single Story State Change"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Story State Change has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_589"}},"schemaId":"schema_589"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_state_changes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_589","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_589"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_state_changes/{id}"}],"content":{"contentType":"group","meta":{"name":"Story State Changes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Story State Changes","showPageActions":true},{"nodeType":"markdoc","content":"Story State Changes in Kantata OX act as an audit trail for changes to the state of a Story.\nStory State Changes cannot be created directly. They will be created for you automatically when you\nset the state of a Story. Story State Changes cannot be modified or deleted."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/story_state_changes","summary":"Fetching a list of Story State Changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/story-state-changes/get story state changes","deprecated":false},{"title":"/story_state_changes/{id}","summary":"Fetching a single Story State Change","prefix":{"name":"get","color":"get"},"badges":[],"link":"/story-state-changes/get story state change","deprecated":false}]}]}]}]}},{"type":"group","label":"Story Tasks","link":"/kantata/specification/story-tasks","routeSlug":"/kantata/specification/story-tasks","items":[{"label":"Fetching a list of Story Tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/story-tasks/get story tasks","routeSlug":"/kantata/specification/story-tasks/get story tasks","metadata":{"seo":{"title":"Fetching a list of Story Tasks","description":"Returns all story tasks belonging to stories in projects that the user is partcipating in."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Story Tasks","name":"Fetching a list of Story Tasks","isWebhook":false,"pointer":"/paths/~1story_tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Story Tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all story tasks belonging to stories in projects that the user is partcipating in."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Story Task objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"story_tasks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `completed_by` (User) - The User who completed this Story task, if any.\n- `story` (Story) - The Story on which this Story Task exists."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_372","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `position:asc` and `position:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"show_archived","in":"query","schemaId":"schema_351","description":"Include Story Tasks on archived Stories."},{"name":"show_deleted","in":"query","schemaId":"schema_351","description":"Include Story Tasks on deleted Stories."},{"name":"show_from_archived_workspaces","in":"query","schemaId":"schema_351","description":"Include Story Tasks on Stories in archived Workspaces."},{"name":"story_id","in":"query","schemaId":"schema_313","description":"Only return the Story Task associated with the specified story_id."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}],"pointer":"/paths/~1story_tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/story_tasks","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_372"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"show_archived","in":"query","schemaId":"schema_351"},{"name":"show_deleted","in":"query","schemaId":"schema_351"},{"name":"show_from_archived_workspaces","in":"query","schemaId":"schema_351"},{"name":"story_id","in":"query","schemaId":"schema_313"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/story_tasks","href":"story-tasks/get story tasks","openApiOperationId":"Get Story Tasks","summary":"Fetching a list of Story Tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Story Tasks have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_590"}},"schemaId":"schema_590"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_tasks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_590","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_590"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_tasks"},{"label":"Creating a new Story Task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/story-tasks/create story task","routeSlug":"/kantata/specification/story-tasks/create story task","metadata":{"seo":{"title":"Creating a new Story Task","description":"This endpoint returns structured Story Task objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the story_tasks top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Story Task","name":"Creating a new Story Task","isWebhook":false,"pointer":"/paths/~1story_tasks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Story Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Story Task objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"story_tasks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `completed_by` (User) - The User who completed this Story task, if any.\n- `story` (Story) - The Story on which this Story Task exists."}],"pointer":"/paths/~1story_tasks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","pointer":"/paths/~1story_tasks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/story_tasks","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_591"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/story_tasks","href":"story-tasks/create story task","openApiOperationId":"Create Story Task","summary":"Creating a new Story Task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_591"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Story Task has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_590"}},"schemaId":"schema_590"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_tasks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_590","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_590"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_tasks"},{"label":"Fetching a single Story Task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/story-tasks/get story task","routeSlug":"/kantata/specification/story-tasks/get story task","metadata":{"seo":{"title":"Fetching a single Story Task","description":"This endpoint returns structured Story Task objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the story_tasks top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Story Task","name":"Fetching a single Story Task","isWebhook":false,"pointer":"/paths/~1story_tasks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Story Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Story Task objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"story_tasks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1story_tasks~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `completed_by` (User) - The User who completed this Story task, if any.\n- `story` (Story) - The Story on which this Story Task exists."}],"pointer":"/paths/~1story_tasks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/story_tasks/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/story_tasks/{id}","href":"story-tasks/get story task","openApiOperationId":"Get Story Task","summary":"Fetching a single Story Task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Story Task has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_590"}},"schemaId":"schema_590"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_tasks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_590","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_590"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_tasks/{id}"},{"label":"Updating an existing Story Task","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/story-tasks/update story task","routeSlug":"/kantata/specification/story-tasks/update story task","metadata":{"seo":{"title":"Updating an existing Story Task","description":"This endpoint returns structured Story Task objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the story_tasks top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Story Task","name":"Updating an existing Story Task","isWebhook":false,"pointer":"/paths/~1story_tasks~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Story Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Story Task objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"story_tasks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1story_tasks~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `completed_by` (User) - The User who completed this Story task, if any.\n- `story` (Story) - The Story on which this Story Task exists."}],"pointer":"/paths/~1story_tasks~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_592"}},"schemaId":"schema_592","pointer":"/paths/~1story_tasks~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/story_tasks/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_592"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/story_tasks/{id}","href":"story-tasks/update story task","openApiOperationId":"Update Story Task","summary":"Updating an existing Story Task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_592","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_592"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Story Task has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_590"}},"schemaId":"schema_590"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_tasks~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_590","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_590"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_tasks/{id}"},{"label":"Deleting an existing Story Task","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/story-tasks/delete story task","routeSlug":"/kantata/specification/story-tasks/delete story task","metadata":{"seo":{"title":"Deleting an existing Story Task","description":"The response will contain no content and an HTTP 204 status code if the request wassuccessful, or a standard Kantata OX error message explaining why the object could not be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Story Task","name":"Deleting an existing Story Task","isWebhook":false,"pointer":"/paths/~1story_tasks~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Story Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1story_tasks~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/story_tasks/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/story_tasks/{id}","href":"story-tasks/delete story task","openApiOperationId":"Delete Story Task","summary":"Deleting an existing Story Task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Story Task has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1story_tasks~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/story_tasks/{id}"}],"content":{"contentType":"group","meta":{"name":"Story Tasks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Story Tasks","showPageActions":true},{"nodeType":"markdoc","content":"Story Tasks are used in Kantata OX to track a list of checklist items within a Story.\nThis model includes a completion boolean and a position integer."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/story_tasks","summary":"Fetching a list of Story Tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/story-tasks/get story tasks","deprecated":false},{"title":"/story_tasks","summary":"Creating a new Story Task","prefix":{"name":"post","color":"post"},"badges":[],"link":"/story-tasks/create story task","deprecated":false},{"title":"/story_tasks/{id}","summary":"Fetching a single Story Task","prefix":{"name":"get","color":"get"},"badges":[],"link":"/story-tasks/get story task","deprecated":false},{"title":"/story_tasks/{id}","summary":"Updating an existing Story Task","prefix":{"name":"put","color":"put"},"badges":[],"link":"/story-tasks/update story task","deprecated":false},{"title":"/story_tasks/{id}","summary":"Deleting an existing Story Task","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/story-tasks/delete story task","deprecated":false}]}]}]}]}},{"type":"separator","label":"Time Tracking","content":null},{"type":"group","label":"Line Item Locks","link":"/kantata/specification/line-item-locks","routeSlug":"/kantata/specification/line-item-locks","items":[{"label":"Fetching a list of Line Item Locks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/line-item-locks/get line item locks","routeSlug":"/kantata/specification/line-item-locks/get line item locks","metadata":{"seo":{"title":"Fetching a list of Line Item Locks","description":"This endpoint returns structured Line Item Lock objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the line_item_locks top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Line Item Locks","name":"Fetching a list of Line Item Locks","isWebhook":false,"pointer":"/paths/~1line_item_locks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Line Item Locks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Line Item Lock objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"line_item_locks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user that set the line item lock on the account."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"pointer":"/paths/~1line_item_locks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/line_item_locks","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/line_item_locks","href":"line-item-locks/get line item locks","openApiOperationId":"Get Line Item Locks","summary":"Fetching a list of Line Item Locks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Line Item Locks have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_593"}},"schemaId":"schema_593"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1line_item_locks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_593","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_593"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/line_item_locks"},{"label":"Creating a new Line Item Lock","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/line-item-locks/create line item lock","routeSlug":"/kantata/specification/line-item-locks/create line item lock","metadata":{"seo":{"title":"Creating a new Line Item Lock","description":"A line item lock will be created on your account at the specified lock date. On successful creation of aline item lock, a representation of it will be returned to you."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Line Item Lock","name":"Creating a new Line Item Lock","isWebhook":false,"pointer":"/paths/~1line_item_locks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Line Item Lock","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A line item lock will be created on your account at the specified lock date. On successful creation of a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"line item lock, a representation of it will be returned to you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your account requires time to be approved, creation will fail unless all time entries before the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified lock date have been approved. The Kantata OX UI has an auto approval tool for your convenience"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if you find yourself in this scenario."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Line Item Lock objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"line_item_locks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user that set the line item lock on the account."}],"pointer":"/paths/~1line_item_locks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1line_item_locks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/line_item_locks","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/line_item_locks","href":"line-item-locks/create line item lock","openApiOperationId":"Create Line Item Lock","summary":"Creating a new Line Item Lock"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Line Item Lock has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_593"}},"schemaId":"schema_593"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1line_item_locks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_593","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_593"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/line_item_locks"},{"label":"Fetching a single Line Item Lock","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/line-item-locks/get line item lock","routeSlug":"/kantata/specification/line-item-locks/get line item lock","metadata":{"seo":{"title":"Fetching a single Line Item Lock","description":"This endpoint returns structured Line Item Lock objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the line_item_locks top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Line Item Lock","name":"Fetching a single Line Item Lock","isWebhook":false,"pointer":"/paths/~1line_item_locks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Line Item Lock","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Line Item Lock objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"line_item_locks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1line_item_locks~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `creator` (User) - The user that set the line item lock on the account."}],"pointer":"/paths/~1line_item_locks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/line_item_locks/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/line_item_locks/{id}","href":"line-item-locks/get line item lock","openApiOperationId":"Get Line Item Lock","summary":"Fetching a single Line Item Lock"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Line Item Lock has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_593"}},"schemaId":"schema_593"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1line_item_locks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_593","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_593"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/line_item_locks/{id}"}],"content":{"contentType":"group","meta":{"name":"Line Item Locks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Line Item Locks","showPageActions":true},{"nodeType":"markdoc","content":"Line Item Locks provide a way for you to lock time in the past so that previous time entries\ncannot be edited or updated and new time entries cannot be created before the selected lock date.\n\nLine Items can be locked to any Saturday in the past on a per-account basis.\n\nKeep in mind that this feature does not lock the ability to invoice approved time entries,\nnor does it lock the submission or approval of expenses.\n\nAlso note: Line Item Locks cannot be modified or deleted. If you would like to move the lock date forward,\nsimply create a new lock at a later date, and your account will be locked at the new date.\nOnce your account has been locked, the lock cannot be moved earlier, or removed."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/line_item_locks","summary":"Fetching a list of Line Item Locks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-item-locks/get line item locks","deprecated":false},{"title":"/line_item_locks","summary":"Creating a new Line Item Lock","prefix":{"name":"post","color":"post"},"badges":[],"link":"/line-item-locks/create line item lock","deprecated":false},{"title":"/line_item_locks/{id}","summary":"Fetching a single Line Item Lock","prefix":{"name":"get","color":"get"},"badges":[],"link":"/line-item-locks/get line item lock","deprecated":false}]}]}]}]}},{"type":"group","label":"Time Entries","link":"/kantata/specification/time-entries","routeSlug":"/kantata/specification/time-entries","items":[{"label":"Fetching a list of Time Entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/time-entries/get time entries","routeSlug":"/kantata/specification/time-entries/get time entries","metadata":{"seo":{"title":"Fetching a list of Time Entries","description":"Returns all time entries visible to the requesting user, unless filter parametershave been applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Time Entries","name":"Fetching a list of Time Entries","isWebhook":false,"pointer":"/paths/~1time_entries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Time Entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all time entries visible to the requesting user, unless filter parameters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"have been applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Time Entry objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"approved","in":"query","schemaId":"schema_305","description":"Filter for time entries that are on approved timesheets or are in a project that does not require approvals. When included in your request, this filter is always processed as `true`; the actual value you provide is ignored."},{"name":"billable","in":"query","schemaId":"schema_305","description":"Return only billable (`true`) or only non-billable (`false`) time entries."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_by","in":"query","schemaId":"schema_313","description":"Filter for time entries created by the specified user."},{"name":"date_performed_between","in":"query","schemaId":"schema_304","description":"Filter for time entries with work performed between 2 dates in a colon-separated YYYY-MM-DD format.\n For example, `2013-06-01:2013-08-01`."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"from_archived_workspaces","in":"query","schemaId":"schema_351","description":"If `true`, includes time entries from archived projects."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"in_active_invoice_id","in":"query","schemaId":"schema_313","description":"Limit results to time entries current in the specified active invoice."},{"name":"in_active_submission","in":"query","schemaId":"schema_305","description":"If true, filters for time entries that are part of active timesheet submissions (`active_submissions`).\n If false, filters for time entries that are not part of an active submission."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `active_submission` (TimesheetSubmission) - Retrieves the active timesheet (i.e. approved or pending) the time entry was submitted on, if any. The response will include `active_submission_id`, which references the data in the `timesheet_submissions` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `invoice` (Invoice) - Retrieves the invoice the time entry was added to, if any. The response will include `invoice_id`, which references the data in the `invoices` top-level key.\n- `recent_submission` (TimesheetSubmission) - Retrieves the most recent timesheet the time entry was submitted on, if any, including any rejected or cancelled timesheets. The response will include `recent_submission_id`, which references the data in the `timesheet_submissions` top-level key.\n- `role` (Role) - Retrieves the project role of the user who performed the work for the time entry, if any. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `story` (Story) - Retrieves the task the time entry is tracked to, if any. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `user` (User) - Retrieves the user the time entry belongs to. The response will include `user_id`, which references the data in the `users` top-level key.\n- `workspace` (Workspace) - Retrieves the project the time entry is tracked to. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"invoiced","in":"query","schemaId":"schema_305","description":"Filter for time entries that have been invoiced. When included in your request, this filter is always processed as `true`; the actual value you provide is ignored. To get uninvoiced time entries instead, use the `uninvoiced` filter."},{"name":"on_my_account","in":"query","schemaId":"schema_321","description":"If `true`, only time entries that are in internal projects (i.e. projects that are on the same account as the authenticated user) are returned. If `false`, time entries that are in both internal and external projects are returned."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"optional_fields","in":"query","schemaId":"schema_595","description":"Allows you to request one or more optional fields as an array."},{"name":"order","in":"query","schemaId":"schema_596","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `created_at:asc`, `created_at:desc`, `date_performed:asc`, `date_performed:desc`, `updated_at:asc`, and `updated_at:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"uninvoiced","in":"query","schemaId":"schema_305","description":"Filter for time entries that have not been invoiced. When included in your request, this filter is always processed as `true`; the actual value you provide is ignored. To get invoiced time entries instead, use the `invoiced` filter."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"with_recent_timesheet_ids","in":"query","schemaId":"schema_304","description":"Filter for time entries from the specified [`TimesheetSubmission`](/tag/Timesheet-Submissions) IDs, including from canceled and rejected reports.\nGive multiple report IDs in a comma separated list.\n\n**Note**: Time entries are only associated with the most recent TimesheetSubmission (see `recent_submission`).\nIf you re-submit time from a canceled or rejected timesheet, a new `TimesheetSubmission` object is created,\nand the time entries will only be returned in association with the new `TimesheetSubmission` from then on,\ninstead of with the canceled or rejected `TimesheetSubmission`.\n\nAlso note that there can only be 1 project per TimesheetSubmission. When a timesheet is submitted through the application frontend with\ntime entries for multiple projects, separate TimesheetSubmission objects are created for each project in the backend."},{"name":"with_timesheet_id","in":"query","schemaId":"schema_313","description":"Filter for time entries from a specified [`TimesheetSubmission`](/tag/Timesheet-Submissions) ID.\n If the timesheet was canceled or rejected, no result is returned."},{"name":"with_user_ids","in":"query","schemaId":"schema_304","description":"Filter for time entries associated with the specified user IDs.\n Give multiple user IDs in a comma separated list. For example, '1,2,3'."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Filter for time entries from the specified project."},{"name":"workspace_ids","in":"query","schemaId":"schema_304","description":"Filter for time entries associated with the specified project IDs.\n Give multiple project IDs in a comma separated list. For example, '1,2,3'."}],"pointer":"/paths/~1time_entries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/time_entries","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"approved","in":"query","schemaId":"schema_305"},{"name":"billable","in":"query","schemaId":"schema_305"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"created_by","in":"query","schemaId":"schema_313"},{"name":"date_performed_between","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"from_archived_workspaces","in":"query","schemaId":"schema_351"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"in_active_invoice_id","in":"query","schemaId":"schema_313"},{"name":"in_active_submission","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"invoiced","in":"query","schemaId":"schema_305"},{"name":"on_my_account","in":"query","schemaId":"schema_321"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_595","style":"form","explode":false},{"name":"order","in":"query","schemaId":"schema_596"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"uninvoiced","in":"query","schemaId":"schema_305"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"with_recent_timesheet_ids","in":"query","schemaId":"schema_304"},{"name":"with_timesheet_id","in":"query","schemaId":"schema_313"},{"name":"with_user_ids","in":"query","schemaId":"schema_304"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","schemaId":"schema_313"},{"name":"workspace_ids","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/time_entries","href":"time-entries/get time entries","openApiOperationId":"Get Time Entries","summary":"Fetching a list of Time Entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Time Entries have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_597"}},"schemaId":"schema_597"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1time_entries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_597","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_597"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/time_entries"},{"label":"Creating a new Time Entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/time-entries/create time entry","routeSlug":"/kantata/specification/time-entries/create time entry","metadata":{"seo":{"title":"Creating a new Time Entry","description":"Creates time entries for a user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Time Entry","name":"Creating a new Time Entry","isWebhook":false,"pointer":"/paths/~1time_entries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creating a new Time Entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates time entries for a user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Create"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"time_entries\": [\n {\n \"workspace_id\": 123,\n \"date_performed\": \"2025-01-23\",\n \"time_in_minutes\": 60\n },\n {\n \"workspace_id\": 123,\n \"date_performed\": \"2025-01-24\",\n \"time_in_minutes\": 60\n }\n ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"time_entries\": [\n {\n \"workspace_id\": 123,\n \"date_performed\": \"2025-01-23\",\n \"time_in_minutes\": 60\n },\n {\n \"workspace_id\": 123,\n \"date_performed\": \"2025-01-24\",\n \"time_in_minutes\": 60\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Time Entry objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `active_submission` (TimesheetSubmission) - Retrieves the active timesheet (i.e. approved or pending) the time entry was submitted on, if any. The response will include `active_submission_id`, which references the data in the `timesheet_submissions` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `invoice` (Invoice) - Retrieves the invoice the time entry was added to, if any. The response will include `invoice_id`, which references the data in the `invoices` top-level key.\n- `recent_submission` (TimesheetSubmission) - Retrieves the most recent timesheet the time entry was submitted on, if any, including any rejected or cancelled timesheets. The response will include `recent_submission_id`, which references the data in the `timesheet_submissions` top-level key.\n- `role` (Role) - Retrieves the project role of the user who performed the work for the time entry, if any. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `story` (Story) - Retrieves the task the time entry is tracked to, if any. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `user` (User) - Retrieves the user the time entry belongs to. The response will include `user_id`, which references the data in the `users` top-level key.\n- `workspace` (Workspace) - Retrieves the project the time entry is tracked to. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_595","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1time_entries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_598"}},"schemaId":"schema_598","pointer":"/paths/~1time_entries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/time_entries","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_595","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_598"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/time_entries","href":"time-entries/create time entry","openApiOperationId":"Create Time Entry","summary":"Creating a new Time Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_598","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_598"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Time Entry has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_597"}},"schemaId":"schema_597"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1time_entries/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_597","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_597"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/time_entries"},{"label":"Delete multiple time entries","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/time-entries/delete time entries","routeSlug":"/kantata/specification/time-entries/delete time entries","metadata":{"seo":{"title":"Delete multiple time entries","description":"The IDs of the time entries to delete can be provided in the ids query parameter or via the request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Time Entries","name":"Delete multiple time entries","isWebhook":false,"pointer":"/paths/~1time_entries/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete multiple time entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs of the time entries to delete can be provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter or via the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" \"ids\": \"1,2,3\"\n}```\n\nIf any specified time entries cannot be deleted, the entire request will fail and an error message\nwill be returned that specifies which ones could not be deleted and why.\n\n\nThis endpoint returns structured Time Entry objects.\nAs with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array\nand will be indexed by ID in the `time_entries` top-level JSON key.\nPlease see our [Response Format](#section/Response-Format) section for more information.","language":"{"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" \"ids\": \"1,2,3\"\n}```\n\nIf any specified time entries cannot be deleted, the entire request will fail and an error message\nwill be returned that specifies which ones could not be deleted and why.\n\n\nThis endpoint returns structured Time Entry objects.\nAs with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array\nand will be indexed by ID in the `time_entries` top-level JSON key.\nPlease see our [Response Format](#section/Response-Format) section for more information."},"children":[]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ids","in":"query","schemaId":"schema_304","description":"A comma-separated list of IDs of time entries. You can provide up to 100 IDs. The IDs can be\nprovided in this query parameter or via the request body."}],"pointer":"/paths/~1time_entries/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/time_entries","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"ids","in":"query","required":false,"schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/time_entries","href":"time-entries/delete time entries","openApiOperationId":"Delete Time Entries","summary":"Delete multiple time entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Time Entry has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1time_entries/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/time_entries"},{"label":"Fetching a single Time Entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/time-entries/get time entry","routeSlug":"/kantata/specification/time-entries/get time entry","metadata":{"seo":{"title":"Fetching a single Time Entry","description":"This endpoint returns structured Time Entry objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the time_entries top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Time Entry","name":"Fetching a single Time Entry","isWebhook":false,"pointer":"/paths/~1time_entries~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Time Entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Time Entry objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1time_entries~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `active_submission` (TimesheetSubmission) - Retrieves the active timesheet (i.e. approved or pending) the time entry was submitted on, if any. The response will include `active_submission_id`, which references the data in the `timesheet_submissions` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `invoice` (Invoice) - Retrieves the invoice the time entry was added to, if any. The response will include `invoice_id`, which references the data in the `invoices` top-level key.\n- `recent_submission` (TimesheetSubmission) - Retrieves the most recent timesheet the time entry was submitted on, if any, including any rejected or cancelled timesheets. The response will include `recent_submission_id`, which references the data in the `timesheet_submissions` top-level key.\n- `role` (Role) - Retrieves the project role of the user who performed the work for the time entry, if any. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `story` (Story) - Retrieves the task the time entry is tracked to, if any. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `user` (User) - Retrieves the user the time entry belongs to. The response will include `user_id`, which references the data in the `users` top-level key.\n- `workspace` (Workspace) - Retrieves the project the time entry is tracked to. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_595","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1time_entries~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/time_entries/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_595","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/time_entries/{id}","href":"time-entries/get time entry","openApiOperationId":"Get Time Entry","summary":"Fetching a single Time Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Time Entry has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_597"}},"schemaId":"schema_597"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1time_entries~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_597","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_597"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/time_entries/{id}"},{"label":"Updating an existing Time Entry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/time-entries/update time entry","routeSlug":"/kantata/specification/time-entries/update time entry","metadata":{"seo":{"title":"Updating an existing Time Entry","description":"This endpoint returns structured Time Entry objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the time_entries top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update Time Entry","name":"Updating an existing Time Entry","isWebhook":false,"pointer":"/paths/~1time_entries~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating an existing Time Entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Time Entry objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1time_entries~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `active_submission` (TimesheetSubmission) - Retrieves the active timesheet (i.e. approved or pending) the time entry was submitted on, if any. The response will include `active_submission_id`, which references the data in the `timesheet_submissions` top-level key.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `invoice` (Invoice) - Retrieves the invoice the time entry was added to, if any. The response will include `invoice_id`, which references the data in the `invoices` top-level key.\n- `recent_submission` (TimesheetSubmission) - Retrieves the most recent timesheet the time entry was submitted on, if any, including any rejected or cancelled timesheets. The response will include `recent_submission_id`, which references the data in the `timesheet_submissions` top-level key.\n- `role` (Role) - Retrieves the project role of the user who performed the work for the time entry, if any. The response will include `role_id`, which references the data in the `roles` top-level key.\n- `story` (Story) - Retrieves the task the time entry is tracked to, if any. The response will include `story_id`, which references the data in the `stories` top-level key.\n- `user` (User) - Retrieves the user the time entry belongs to. The response will include `user_id`, which references the data in the `users` top-level key.\n- `workspace` (Workspace) - Retrieves the project the time entry is tracked to. The response will include `workspace_id`, which references the data in the `workspaces` top-level key."},{"name":"optional_fields","in":"query","schemaId":"schema_595","description":"Allows you to request one or more optional fields as an array."}],"pointer":"/paths/~1time_entries~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_599"}},"schemaId":"schema_599","pointer":"/paths/~1time_entries~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/time_entries/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"},{"name":"optional_fields","in":"query","schemaId":"schema_595","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_599"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/time_entries/{id}","href":"time-entries/update time entry","openApiOperationId":"Update Time Entry","summary":"Updating an existing Time Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_599","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_599"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Time Entry has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_597"}},"schemaId":"schema_597"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1time_entries~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_597","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_597"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/time_entries/{id}"},{"label":"Deleting an existing Time Entry","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/time-entries/delete time entry","routeSlug":"/kantata/specification/time-entries/delete time entry","metadata":{"seo":{"title":"Deleting an existing Time Entry","description":"Deletes the time entry if it is deletable. A time entry cannot be destroyed if:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete Time Entry","name":"Deleting an existing Time Entry","isWebhook":false,"pointer":"/paths/~1time_entries~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting an existing Time Entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the time entry if it is deletable. A time entry cannot be destroyed if:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the time is locked before a certain date,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the time has been invoiced, or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a time adjustment is linked with it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will contain no content and an HTTP 204 status code if the request was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful, or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard Kantata OX error message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why the object could not be deleted."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1time_entries~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/time_entries/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/time_entries/{id}","href":"time-entries/delete time entry","openApiOperationId":"Delete Time Entry","summary":"Deleting an existing Time Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Time Entry has been deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1time_entries~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/time_entries/{id}"}],"content":{"contentType":"group","meta":{"name":"Time Entries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Time Entries","showPageActions":true},{"nodeType":"markdoc","content":"This object allows you to manage Kantata OX time entries, depending on your permissions.\nCreating and updating time entries allows you to include time when invoicing clients."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/time_entries","summary":"Fetching a list of Time Entries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/time-entries/get time entries","deprecated":false},{"title":"/time_entries","summary":"Creating a new Time Entry","prefix":{"name":"post","color":"post"},"badges":[],"link":"/time-entries/create time entry","deprecated":false},{"title":"/time_entries","summary":"Delete multiple time entries","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/time-entries/delete time entries","deprecated":false},{"title":"/time_entries/{id}","summary":"Fetching a single Time Entry","prefix":{"name":"get","color":"get"},"badges":[],"link":"/time-entries/get time entry","deprecated":false},{"title":"/time_entries/{id}","summary":"Updating an existing Time Entry","prefix":{"name":"put","color":"put"},"badges":[],"link":"/time-entries/update time entry","deprecated":false},{"title":"/time_entries/{id}","summary":"Deleting an existing Time Entry","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/time-entries/delete time entry","deprecated":false}]}]}]}]}},{"type":"group","label":"Timesheet Approvals","link":"/kantata/specification/timesheet-approvals","routeSlug":"/kantata/specification/timesheet-approvals","items":[{"label":"Approve Multiple Timesheet Submissions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/timesheet-approvals/approve timesheet submissions","routeSlug":"/kantata/specification/timesheet-approvals/approve timesheet submissions","metadata":{"seo":{"title":"Approve Multiple Timesheet Submissions","description":"This endpoint allows you to approve multiple pending Timesheet Submissions at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Approve Timesheet Submissions","name":"Approve Multiple Timesheet Submissions","isWebhook":false,"pointer":"/paths/~1timesheet_approvals/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approve Multiple Timesheet Submissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to approve multiple pending Timesheet Submissions at once."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Resolution objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolutions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_600"}},"schemaId":"schema_600","pointer":"/paths/~1timesheet_approvals/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/timesheet_approvals","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_600"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/timesheet_approvals","href":"timesheet-approvals/approve timesheet submissions","openApiOperationId":"Approve Timesheet Submissions","summary":"Approve Multiple Timesheet Submissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_600","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_600"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resolution has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_601"}},"schemaId":"schema_601"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1timesheet_approvals/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_601","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_601"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/timesheet_approvals"}],"content":{"contentType":"group","meta":{"name":"Timesheet Approvals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Timesheet Approvals","showPageActions":true},{"nodeType":"markdoc","content":"This section contains an endpoint to approve multiple Timesheet Submissions at once."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/timesheet_approvals","summary":"Approve Multiple Timesheet Submissions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/timesheet-approvals/approve timesheet submissions","deprecated":false}]}]}]}]}},{"type":"group","label":"Timesheet Cancellations","link":"/kantata/specification/timesheet-cancellations","routeSlug":"/kantata/specification/timesheet-cancellations","items":[{"label":"Cancel Multiple Timesheet Submissions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/timesheet-cancellations/cancel timesheet submissions","routeSlug":"/kantata/specification/timesheet-cancellations/cancel timesheet submissions","metadata":{"seo":{"title":"Cancel Multiple Timesheet Submissions","description":"This endpoint allows you to cancel multiple Timesheet Submissions at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Cancel Timesheet Submissions","name":"Cancel Multiple Timesheet Submissions","isWebhook":false,"pointer":"/paths/~1timesheet_cancellations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Multiple Timesheet Submissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to cancel multiple Timesheet Submissions at once."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Resolution objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolutions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_600"}},"schemaId":"schema_600","pointer":"/paths/~1timesheet_cancellations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/timesheet_cancellations","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_600"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/timesheet_cancellations","href":"timesheet-cancellations/cancel timesheet submissions","openApiOperationId":"Cancel Timesheet Submissions","summary":"Cancel Multiple Timesheet Submissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_600","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_600"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resolution has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_601"}},"schemaId":"schema_601"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1timesheet_cancellations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_601","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_601"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/timesheet_cancellations"}],"content":{"contentType":"group","meta":{"name":"Timesheet Cancellations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Timesheet Cancellations","showPageActions":true},{"nodeType":"markdoc","content":"This section contains an endpoint to cancel multiple Timesheet Submissions at once."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/timesheet_cancellations","summary":"Cancel Multiple Timesheet Submissions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/timesheet-cancellations/cancel timesheet submissions","deprecated":false}]}]}]}]}},{"type":"group","label":"Timesheet Rejections","link":"/kantata/specification/timesheet-rejections","routeSlug":"/kantata/specification/timesheet-rejections","items":[{"label":"Reject Multiple Timesheet Submissions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/timesheet-rejections/reject timesheet submissions","routeSlug":"/kantata/specification/timesheet-rejections/reject timesheet submissions","metadata":{"seo":{"title":"Reject Multiple Timesheet Submissions","description":"This endpoint allows you to reject multiple Timesheet Submissions at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Reject Timesheet Submissions","name":"Reject Multiple Timesheet Submissions","isWebhook":false,"pointer":"/paths/~1timesheet_rejections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reject Multiple Timesheet Submissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to reject multiple Timesheet Submissions at once."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Resolution objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolutions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_600"}},"schemaId":"schema_600","pointer":"/paths/~1timesheet_rejections/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/timesheet_rejections","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_600"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/timesheet_rejections","href":"timesheet-rejections/reject timesheet submissions","openApiOperationId":"Reject Timesheet Submissions","summary":"Reject Multiple Timesheet Submissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_600","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_600"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resolution has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_601"}},"schemaId":"schema_601"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1timesheet_rejections/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_601","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_601"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/timesheet_rejections"}],"content":{"contentType":"group","meta":{"name":"Timesheet Rejections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Timesheet Rejections","showPageActions":true},{"nodeType":"markdoc","content":"This section contains an endpoint to reject multiple Timesheet Submissions at once."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/timesheet_rejections","summary":"Reject Multiple Timesheet Submissions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/timesheet-rejections/reject timesheet submissions","deprecated":false}]}]}]}]}},{"type":"group","label":"Timesheet Submissions","link":"/kantata/specification/timesheet-submissions","routeSlug":"/kantata/specification/timesheet-submissions","items":[{"label":"Fetching a list of Timesheet Submissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/timesheet-submissions/get timesheet submissions","routeSlug":"/kantata/specification/timesheet-submissions/get timesheet submissions","metadata":{"seo":{"title":"Fetching a list of Timesheet Submissions","description":"This endpoint returns structured Timesheet Submission objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the timesheet_submissions top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Timesheet Submissions","name":"Fetching a list of Timesheet Submissions","isWebhook":false,"pointer":"/paths/~1timesheet_submissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a list of Timesheet Submissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Timesheet Submission objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timesheet_submissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"active","in":"query","schemaId":"schema_305","description":"Returns only active submissions."},{"name":"created_after","in":"query","schemaId":"schema_303","description":"Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"created_before","in":"query","schemaId":"schema_303","description":"Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"end_date","in":"query","schemaId":"schema_368","description":"Limit Timesheet Submissions to the week ending with this date. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304","description":"Filter the objects based on the external message of their associated external references. This is an exact match."},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the external object in the external system."},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304","description":"Filter by the type of the external object this external reference belongs to."},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313","description":"Filter by the id of the external object this external reference belongs to."},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304","description":"Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs."},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304","description":"Filter by the name of the provider for integration."},{"name":"external_reference_status","in":"query","schemaId":"schema_304","description":"Filter by the status of the integration, this can be successful or fail."},{"name":"has_external_references","in":"query","schemaId":"schema_305","description":"Filter by whether or not the object has external references."},{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `time_entries` (TimeEntry) - Reference the Time Entries that belong to the Timesheet Submissions.\n- `user` (User) - Includes user who owns the line items on the submission.\n- `workspace` (Workspace) - Includes workspace to which the submission belongs."},{"name":"not_cancelled","in":"query","schemaId":"schema_305","description":"Returns only submissions that are not cancelled."},{"name":"only","in":"query","schemaId":"schema_304","description":"Allows you to request one or more resources directly by ID. Multiple IDs can be supplied\nin a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`."},{"name":"order","in":"query","schemaId":"schema_414","description":"Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\nValid values: `date:asc` and `date:desc`."},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"start_date","in":"query","schemaId":"schema_368","description":"Limit Timesheet Submissions to the week starting with this date. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"start_date_after","in":"query","schemaId":"schema_368","description":"Filter for Timesheet Submissions that start on OR after a specified datetime. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"statuses","in":"query","schemaId":"schema_304","description":"Returns submissions with the statuses specified. Multiple statuses can be supplied in a comma separated list.\nValid values: ‘new’, ‘cancelled’, ‘rejected’, and ‘approved’."},{"name":"updated_after","in":"query","schemaId":"schema_303","description":"Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"updated_before","in":"query","schemaId":"schema_303","description":"Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},{"name":"user_ids","in":"query","schemaId":"schema_304","description":"Only includes submissions associated with the specified user ids."},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304","description":"Exclude by the existence of an external reference with the specified service name."},{"name":"workspace_id","in":"query","schemaId":"schema_313","description":"Ordered by the submission's workspace id."},{"name":"workspace_ids","in":"query","schemaId":"schema_304","description":"Only includes submissions associated with the specified workspace ids."}],"pointer":"/paths/~1timesheet_submissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/timesheet_submissions","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"active","in":"query","schemaId":"schema_305"},{"name":"created_after","in":"query","schemaId":"schema_303"},{"name":"created_before","in":"query","schemaId":"schema_303"},{"name":"end_date","in":"query","schemaId":"schema_368"},{"name":"external_reference_external_message","in":"query","schemaId":"schema_304"},{"name":"external_reference_external_status","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_model_ref","in":"query","schemaId":"schema_313"},{"name":"external_reference_service_model_refs","in":"query","schemaId":"schema_304"},{"name":"external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"external_reference_status","in":"query","schemaId":"schema_304"},{"name":"has_external_references","in":"query","schemaId":"schema_305"},{"name":"include","in":"query","schemaId":"schema_304"},{"name":"not_cancelled","in":"query","schemaId":"schema_305"},{"name":"only","in":"query","schemaId":"schema_304"},{"name":"order","in":"query","schemaId":"schema_414"},{"name":"page","in":"query","schemaId":"schema_308"},{"name":"per_page","in":"query","schemaId":"schema_309"},{"name":"start_date","in":"query","schemaId":"schema_368"},{"name":"start_date_after","in":"query","schemaId":"schema_368"},{"name":"statuses","in":"query","schemaId":"schema_304"},{"name":"updated_after","in":"query","schemaId":"schema_303"},{"name":"updated_before","in":"query","schemaId":"schema_303"},{"name":"user_ids","in":"query","schemaId":"schema_304"},{"name":"without_external_reference_service_name","in":"query","schemaId":"schema_304"},{"name":"workspace_id","in":"query","schemaId":"schema_313"},{"name":"workspace_ids","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/timesheet_submissions","href":"timesheet-submissions/get timesheet submissions","openApiOperationId":"Get Timesheet Submissions","summary":"Fetching a list of Timesheet Submissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Timesheet Submissions have been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}},"schemaId":"schema_602"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1timesheet_submissions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_602","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/timesheet_submissions"},{"label":"Create a Timesheet Submission","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/timesheet-submissions/create timesheet submission","routeSlug":"/kantata/specification/timesheet-submissions/create timesheet submission","metadata":{"seo":{"title":"Create a Timesheet Submission","description":"Create a new TimesheetSubmission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create Timesheet Submission","name":"Create a Timesheet Submission","isWebhook":false,"pointer":"/paths/~1timesheet_submissions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Timesheet Submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new TimesheetSubmission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A TimesheetSubmission can be associated with only one project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Timesheet Submission objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timesheet_submissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `time_entries` (TimeEntry) - Reference the Time Entries that belong to the Timesheet Submissions.\n- `user` (User) - Includes user who owns the line items on the submission.\n- `workspace` (Workspace) - Includes workspace to which the submission belongs."}],"pointer":"/paths/~1timesheet_submissions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_603"}},"schemaId":"schema_603","pointer":"/paths/~1timesheet_submissions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/timesheet_submissions","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_603"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/timesheet_submissions","href":"timesheet-submissions/create timesheet submission","openApiOperationId":"Create Timesheet Submission","summary":"Create a Timesheet Submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_603","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_603"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Timesheet Submission has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}},"schemaId":"schema_602"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1timesheet_submissions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_602","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/timesheet_submissions"},{"label":"Fetching a single Timesheet Submission","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/timesheet-submissions/get timesheet submission","routeSlug":"/kantata/specification/timesheet-submissions/get timesheet submission","metadata":{"seo":{"title":"Fetching a single Timesheet Submission","description":"This endpoint returns structured Timesheet Submission objects.As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results arrayand will be indexed by ID in the timesheet_submissions top-level JSON key.Please see our Response Format section for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get Timesheet Submission","name":"Fetching a single Timesheet Submission","isWebhook":false,"pointer":"/paths/~1timesheet_submissions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetching a single Timesheet Submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Timesheet Submission objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timesheet_submissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1timesheet_submissions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `time_entries` (TimeEntry) - Reference the Time Entries that belong to the Timesheet Submissions.\n- `user` (User) - Includes user who owns the line items on the submission.\n- `workspace` (Workspace) - Includes workspace to which the submission belongs."}],"pointer":"/paths/~1timesheet_submissions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/timesheet_submissions/{id}","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/timesheet_submissions/{id}","href":"timesheet-submissions/get timesheet submission","openApiOperationId":"Get Timesheet Submission","summary":"Fetching a single Timesheet Submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Timesheet Submission has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}},"schemaId":"schema_602"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1timesheet_submissions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_602","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/timesheet_submissions/{id}"},{"label":"Approve a Single Timesheet Submission","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/timesheet-submissions/approve timesheet submission","routeSlug":"/kantata/specification/timesheet-submissions/approve timesheet submission","metadata":{"seo":{"title":"Approve a Single Timesheet Submission","description":"Approves a single Timesheet Submission. You must haveTime Approval permissionsto use this endpoint. To approve multiple Timesheet Submissions at once, seeTimesheet Approvals."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Approve Timesheet Submission","name":"Approve a Single Timesheet Submission","isWebhook":false,"pointer":"/paths/~1timesheet_submissions~1{id}~1approve/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approve a Single Timesheet Submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approves a single Timesheet Submission. You must have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/203740920"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time Approval permissions"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to use this endpoint. To approve multiple Timesheet Submissions at once, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Timesheet-Approvals"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timesheet Approvals"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Timesheet Submission objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timesheet_submissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1timesheet_submissions~1{id}~1approve/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `time_entries` (TimeEntry) - Reference the Time Entries that belong to the Timesheet Submissions.\n- `user` (User) - Includes user who owns the line items on the submission.\n- `workspace` (Workspace) - Includes workspace to which the submission belongs."}],"pointer":"/paths/~1timesheet_submissions~1{id}~1approve/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1timesheet_submissions~1{id}~1approve/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/timesheet_submissions/{id}/approve","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/timesheet_submissions/{id}/approve","href":"timesheet-submissions/approve timesheet submission","openApiOperationId":"Approve Timesheet Submission","summary":"Approve a Single Timesheet Submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Timesheet Submission has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}},"schemaId":"schema_602"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1timesheet_submissions~1{id}~1approve/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_602","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/timesheet_submissions/{id}/approve"},{"label":"Cancel a Single Timesheet Submission","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/timesheet-submissions/cancel timesheet submission","routeSlug":"/kantata/specification/timesheet-submissions/cancel timesheet submission","metadata":{"seo":{"title":"Cancel a Single Timesheet Submission","description":"Cancels a single Timesheet Submission. You must haveTime Approval permissionsto use this endpoint. To cancel multiple Timesheet Submissions at once, seeTimesheet Cancellations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Cancel Timesheet Submission","name":"Cancel a Single Timesheet Submission","isWebhook":false,"pointer":"/paths/~1timesheet_submissions~1{id}~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a Single Timesheet Submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a single Timesheet Submission. You must have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/203740920"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time Approval permissions"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to use this endpoint. To cancel multiple Timesheet Submissions at once, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Timesheet-Cancellations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timesheet Cancellations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Timesheet Submission objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timesheet_submissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1timesheet_submissions~1{id}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `time_entries` (TimeEntry) - Reference the Time Entries that belong to the Timesheet Submissions.\n- `user` (User) - Includes user who owns the line items on the submission.\n- `workspace` (Workspace) - Includes workspace to which the submission belongs."}],"pointer":"/paths/~1timesheet_submissions~1{id}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1timesheet_submissions~1{id}~1cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/timesheet_submissions/{id}/cancel","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/timesheet_submissions/{id}/cancel","href":"timesheet-submissions/cancel timesheet submission","openApiOperationId":"Cancel Timesheet Submission","summary":"Cancel a Single Timesheet Submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Timesheet Submission has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}},"schemaId":"schema_602"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1timesheet_submissions~1{id}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_602","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/timesheet_submissions/{id}/cancel"},{"label":"Reject a Single Timesheet Submission","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/kantata/specification/timesheet-submissions/reject timesheet submission","routeSlug":"/kantata/specification/timesheet-submissions/reject timesheet submission","metadata":{"seo":{"title":"Reject a Single Timesheet Submission","description":"Rejects a single Timesheet Submission. You must haveTime Approval permissionsto use this endpoint. To reject multiple Timesheet Submissions at once, seeTimesheet Rejections."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Reject Timesheet Submission","name":"Reject a Single Timesheet Submission","isWebhook":false,"pointer":"/paths/~1timesheet_submissions~1{id}~1reject/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reject a Single Timesheet Submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejects a single Timesheet Submission. You must have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/203740920"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time Approval permissions"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to use this endpoint. To reject multiple Timesheet Submissions at once, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Timesheet-Rejections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timesheet Rejections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns structured Timesheet Submission objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and will be indexed by ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timesheet_submissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" top-level JSON key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Response-Format"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more information."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_316","description":"The ID of the Model.","required":true}],"pointer":"/paths/~1timesheet_submissions~1{id}~1reject/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_304","description":"Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.\n- `external_references` (ExternalReference) - Includes references to external integrations for this object.\n- `time_entries` (TimeEntry) - Reference the Time Entries that belong to the Timesheet Submissions.\n- `user` (User) - Includes user who owns the line items on the submission.\n- `workspace` (Workspace) - Includes workspace to which the submission belongs."}],"pointer":"/paths/~1timesheet_submissions~1{id}~1reject/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1timesheet_submissions~1{id}~1reject/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/timesheet_submissions/{id}/reject","servers":[{"url":"https://api.mavenlink.com/api/v1"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_316"}],"query":[{"name":"include","in":"query","schemaId":"schema_304"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/timesheet_submissions/{id}/reject","href":"timesheet-submissions/reject timesheet submission","openApiOperationId":"Reject Timesheet Submission","summary":"Reject a Single Timesheet Submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Timesheet Submission has been updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}},"schemaId":"schema_602"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"403","description":"Forbidden request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"404","description":"Page Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"503","description":"Service is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"}],"pointer":"/paths/~1timesheet_submissions~1{id}~1reject/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_602","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"403","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"404","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"422","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"503","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}}],"examples":[]}]}]}]},"httpPath":"/timesheet_submissions/{id}/reject"}],"content":{"contentType":"group","meta":{"name":"Timesheet Submissions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Timesheet Submissions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timesheet Submissions hold a set of time entries for a specified week, and can be approved, rejected,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can enable timesheet submissions and approval in your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledge.kantata.com/hc/en-us/articles/204346530#Financials"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"project settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once enabled, time entries must be approved through a Timesheet Submission before it is invoiceable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Each Timesheet Submission can only be associated with a single project. So when a timesheet"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is submitted through the UI with time entries for multiple projects, a separate Timesheet Submission"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object is created for each project in the backend."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section contains endpoints to approve, reject, or cancel a single timesheet submission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To approve, reject, or cancel multiple timesheet submissions at once, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Timesheet-Approvals"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timesheet Approvals"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Timesheet-Cancellations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timesheet Cancellations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/tag/Timesheet-Rejections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timesheet Rejections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/timesheet_submissions","summary":"Fetching a list of Timesheet Submissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/timesheet-submissions/get timesheet submissions","deprecated":false},{"title":"/timesheet_submissions","summary":"Create a Timesheet Submission","prefix":{"name":"post","color":"post"},"badges":[],"link":"/timesheet-submissions/create timesheet submission","deprecated":false},{"title":"/timesheet_submissions/{id}","summary":"Fetching a single Timesheet Submission","prefix":{"name":"get","color":"get"},"badges":[],"link":"/timesheet-submissions/get timesheet submission","deprecated":false},{"title":"/timesheet_submissions/{id}/approve","summary":"Approve a Single Timesheet Submission","prefix":{"name":"put","color":"put"},"badges":[],"link":"/timesheet-submissions/approve timesheet submission","deprecated":false},{"title":"/timesheet_submissions/{id}/cancel","summary":"Cancel a Single Timesheet Submission","prefix":{"name":"put","color":"put"},"badges":[],"link":"/timesheet-submissions/cancel timesheet submission","deprecated":false},{"title":"/timesheet_submissions/{id}/reject","summary":"Reject a Single Timesheet Submission","prefix":{"name":"put","color":"put"},"badges":[],"link":"/timesheet-submissions/reject timesheet submission","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AccessGroupMembership":{"id":"components/schemas/AccessGroupMembership","kind":"json-schema","title":"Access Group Membership","data":{"title":"Access Group Membership","description":"Access Groups allow you to manage product access for users. An Access Group Membership represents the connection of a user to an Access Group.","type":"object","properties":{"access_group_id":{"type":"integer","format":"int32","description":"The ID of the associated access group."},"access_group_name":{"type":"string","description":"The name of the associated access group."},"created_at":{"type":"string","format":"date","description":"When the access group membership was created (i.e. when the user was added to the access group)."},"creator_id":{"type":"integer","format":"int32","description":"The ID of the user that created the access group membership (i.e. the person that added the user to the access group)."},"user_id":{"type":"integer","format":"int32","description":"The ID of the associated user."},"user_name":{"type":"string","description":"The name of the associated user."}}}},"components/schemas/AccountColor":{"id":"components/schemas/AccountColor","kind":"json-schema","title":"Account Color","data":{"title":"Account Color","description":"A color on the user's account that can be associated with a project.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"default_color":{"type":"boolean","description":"Whether the color is the account default. Each account can only have one default color."},"enabled":{"type":"boolean","description":"Whether the color is enabled on the account."},"hex":{"type":"string","description":"The hex value of the color in the format #XXXXXX."},"name":{"type":"string","description":"The human readable color name."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/AccountDataExportResult":{"id":"components/schemas/AccountDataExportResult","kind":"json-schema","title":"Data Export","data":{"title":"Data Export","description":"Account data exports are used to download account data from Kantata OX.","type":"object","properties":{"account_id":{"type":"integer","format":"int32","description":"The account ID the export was generated for."},"created_at":{"type":"string","format":"date-time","description":"The date and time the export was generated."},"export_definition":{"type":"object","description":"The data set and columns that were exported.","additionalProperties":{"type":"object","description":"The `key` value for a data set.","properties":{"display_name":{"type":"string","description":"The name of the data set as it appears in the Data Exporter."},"key":{"type":"string","description":"The `key` value for a data set."},"columns":{"type":"array","description":"The columns included in the export.","items":{"type":"object","properties":{"key":{"type":"string","description":"The `key` value for a column in a data set."},"display_name":{"type":"string","description":"The names of columns as they appear in the Data Exporter."},"description":{"type":"string","description":"The description of a column in an export."},"type":{"type":"string","description":"The data type of a column."}}}},"filters":{"type":"object","description":"The filters that were applied to the export.","properties":{"start_date":{"type":"string","format":"date","description":"The start date the export was filtered by, which restricts data to objects that were created on or after the given date."},"end_date":{"type":"string","format":"date","description":"The end date the export was filtered by, which restricts data to objects that were created on or before the given date."}}}}}},"status":{"type":"string","description":"The status of an export."},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."}}}},"components/schemas/AccountInsightsMapping":{"id":"components/schemas/AccountInsightsMapping","kind":"json-schema","title":"Account Insights Mapping","data":{"title":"Account Insights Mapping","description":"Account Insights Mapping represent the Insights dashboards on your account.","type":"object","properties":{"access_group_ids":{"type":"array","items":{"type":"string"},"description":"`access_group_ids` will only be included in the response if `access_groups` is in the list of included associations. See include section for usage."},"creator":{"type":"string","description":"The name of the person that created the dashboard."},"dynamic":{"type":"boolean","description":"Whether the dashboard is a dynamic dashboard."},"is_custom_dashboard":{"type":"boolean","description":"Whether the dashboard is a standard (`false`) or custom (`true`) dashboard."},"name":{"type":"string","description":"The name of the dashboard."}}}},"components/schemas/AccountInvitation":{"id":"components/schemas/AccountInvitation","kind":"json-schema","title":"Account Invitation","data":{"title":"Account Invitation","description":"The Account Invitation represents an invitation to join an existing Kantata OX account as a user.","type":"object","properties":{"bill_rate_in_cents":{"type":"integer","format":"int32","description":"The default billing rate, in cents, for the user in a workspace on this account.\nVisible when the API user is on the invitation account. and the API user is an Account Project Lead.."},"billability_target":{"type":"integer","format":"int32","description":"\nVisible when the API user is on the invitation account. and the API user is an Account Project Lead.."},"cost_rate_in_cents":{"type":"integer","format":"int32","description":"The default cost rate, in cents, for the user in a workspace on this account.\nVisible when the API user is on the invitation account. and the API user is an Account Administrator.."},"default_role_id":{"type":"string","description":"`default_role_id` will only be included in the response if `default_role` is in the list of included associations. See include section for usage."},"email_address":{"type":"string","description":"The email address of the invited user. An email is sent to this address with a link to accept the invitation."},"expiration_date":{"type":"string","description":"The invitation's expiration date."},"full_name":{"type":"string","description":"The full name of the invited user."},"headline":{"type":"string"},"invitee_id":{"type":"string","description":"`invitee_id` will only be included in the response if `invitee` is in the list of included associations. See include section for usage."},"inviter_id":{"type":"string","description":"`inviter_id` will only be included in the response if `inviter` is in the list of included associations. See include section for usage."},"pending":{"type":"boolean","description":"The status of the invitation."},"permission":{"type":"string","description":"The access level that the invited user will have (one of administrator, reports_viewer_with_cost, reports_viewer, project_lead, project_creator, collaborator, and punch_clock)."}}}},"components/schemas/AccountLocation":{"id":"components/schemas/AccountLocation","kind":"json-schema","title":"Account Location","data":{"title":"Account Location","description":"Represents a location associated with an account.","type":"object","properties":{"archived":{"type":"boolean","description":"Whether the Account Location is archived."},"in_use":{"type":"boolean","description":"Whether the Account Location is in use."},"name":{"type":"string","description":"The location the Account Location represents."}}}},"components/schemas/AccountMembership":{"id":"components/schemas/AccountMembership","kind":"json-schema","title":"Account Membership","data":{"title":"Account Membership","description":"An Account Membership represents the relationship of a user to an account.","type":"object","properties":{"backup_approver_association_ids":{"type":"array","items":{"type":"string"},"description":"`backup_approver_association_ids` will only be included in the response if `backup_approver_associations` is in the list of included associations. See include section for usage."},"bill_rate_in_cents":{"type":"integer","format":"int32","description":"The default billing rate, in cents, for the user in a workspace on this account when the workspace\ndoes not use rate card. This attribute is only accessible if the current user is a Project Lead.\nVisible when the account membership is on the same account as the API user. and the API user is an Account Project Lead.."},"billability_target":{"type":"integer","format":"int32","description":"\nVisible when the account membership is on the same account as the API user. and the API user is an Account Project Lead.."},"can_create_workspace":{"type":"boolean","description":"Whether the user can create projects."},"can_log_in":{"type":"boolean","description":"Whether the user can log in.\nOnly returned when requested through the optional_fields param."},"can_view_reports":{"type":"boolean","description":"Whether the user can view reports."},"collaborator_only_license":{"type":"boolean","description":"Whether the user is always a Collaborator in projects.\nVisible when the account membership is on the same account as the API user.."},"cost_rate_ids":{"type":"array","items":{"type":"string"},"description":"`cost_rate_ids` will only be included in the response if `cost_rates` is in the list of included associations. See include section for usage."},"cost_rate_in_cents":{"type":"integer","format":"int32","description":"The default cost rate, in cents, for the user in a workspace on this account. This attribute is only\naccessible if the current user is an Administrator on the account.\nVisible when the account membership is on the same account as the API user. and the API user is an Account Administrator.."},"created_at":{"type":"string","format":"date-time"},"default_read_only":{"type":"boolean","description":"Whether the user is always read-only in projects."},"default_role_id":{"type":"string","description":"`default_role_id` will only be included in the response if `default_role` is in the list of included associations. See include section for usage."},"disabled_at":{"type":"string","format":"date-time","description":"The date when the account membership was disabled."},"effective_workweek_id":{"type":"string","description":"`effective_workweek_id` will only be included in the response if `effective_workweek` is in the list of included associations. See include section for usage."},"future_billable_utilization_ids":{"type":"array","items":{"type":"string"},"description":"`future_billable_utilization_ids` will only be included in the response if `future_billable_utilizations` is in the list of included associations. See include section for usage."},"is_administrator":{"type":"boolean","description":"Whether the user is an Administrator."},"is_backup_approver":{"type":"boolean","description":"Whether the user is a backup approver for others users on the account."},"is_owner":{"type":"boolean","description":"The owner of the account."},"is_project_lead":{"type":"boolean","description":"Whether the user is a Project Lead."},"is_punch_clock_user":{"type":"boolean","description":"Whether the user is a Punch Clock User."},"managee_ids":{"type":"array","items":{"type":"string"},"description":"`managee_ids` will only be included in the response if `managees` is in the list of included associations. See include section for usage."},"manager_can_approve":{"type":"boolean","description":"If present, the assigned manager can approve submitted time and expenses."},"manager_can_edit_skills":{"type":"boolean","description":"If present, the assigned manager can edit the user's skills."},"manager_id":{"type":"string","description":"`manager_id` will only be included in the response if `manager` is in the list of included associations. See include section for usage."},"non_participant":{"type":"boolean","description":"\nVisible when the account membership is on the same account as the API user..\n\nOnly returned when requested through the optional_fields param."},"permission":{"type":"string","description":"The user's access level. Options are administrator, reports_viewer_with_cost, reports_viewer, project_lead, project_creator, collaborator, external_collaborator, and punch_clock."},"possible_managee_ids":{"type":"array","items":{"type":"string"},"description":"`possible_managee_ids` will only be included in the response if `possible_managees` is in the list of included associations. See include section for usage."},"possible_manager_ids":{"type":"array","items":{"type":"string"},"description":"`possible_manager_ids` will only be included in the response if `possible_managers` is in the list of included associations. See include section for usage."},"should_show_alert_on_timesheet_submission":{"type":"boolean","description":"Show an alert on a user's timesheet submission."},"skill_membership_ids":{"type":"array","items":{"type":"string"},"description":"`skill_membership_ids` will only be included in the response if `skill_memberships` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."}}}},"components/schemas/AdditionalItem":{"id":"components/schemas/AdditionalItem","kind":"json-schema","title":"Additional Item","data":{"title":"Additional Item","type":"object","properties":{"amount_in_cents":{"type":"integer","format":"int32"},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"notes":{"type":"string"},"taxable":{"type":"boolean"},"workspace_id":{"type":"integer","format":"int32"}}}},"components/schemas/Assignment":{"id":"components/schemas/Assignment","kind":"json-schema","title":"Assignment","data":{"title":"Assignment","description":"An Assignment represents the relationship of a resource to a task. It owns\nStory Allocation Days.","type":"object","properties":{"allocated_minutes":{"type":"integer","format":"int32","description":"The calculated sum of the assignment's Story Allocation Day minutes."},"assignee_id":{"type":"string","description":"`assignee_id` will only be included in the response if `assignee` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time"},"current":{"type":"boolean","description":"Whether the assignment is active."},"estimated_minutes":{"type":"integer","format":"int32","description":"The estimated number of minutes that the resource is expected to work on this task."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"resource_id":{"type":"integer","format":"int32","description":"The ID of the resource who owns the assignment."},"story_allocation_day_ids":{"type":"array","items":{"type":"string"},"description":"`story_allocation_day_ids` will only be included in the response if `story_allocation_days` is in the list of included associations. See include section for usage."},"story_id":{"type":"string","description":"`story_id` will only be included in the response if `story` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/BackupApproverAssociation":{"id":"components/schemas/BackupApproverAssociation","kind":"json-schema","title":"Backup Approver Association","data":{"title":"Backup Approver Association","description":"Backup Approver Associations describe when a backup approver will be active, or responsible\nfor approving time.","type":"object","properties":{"approver_id":{"type":"string","description":"`approver_id` will only be included in the response if `approver` is in the list of included associations. See include section for usage."},"backup_approver_id":{"type":"string","description":"`backup_approver_id` will only be included in the response if `backup_approver` is in the list of included associations. See include section for usage."},"end_date":{"type":"string","format":"date-time","description":"The backup approver end date."},"start_date":{"type":"string","format":"date-time","description":"The backup approver start date."}}}},"components/schemas/BaselinePayload":{"id":"components/schemas/BaselinePayload","kind":"json-schema","title":"Baseline Payload","data":{"title":"Baseline Payload","description":"A Baseline Payload is associate with one Workspace Baseline.\n\nThe `raw_data` attribute contains a snapshot of all the stories in the workspace. It tracks the following\nattributes for each Story:\n\n* Start Date\n* Due Date\n* Percentage Complete.","type":"object","properties":{"raw_data":{"type":"string","description":"A JSON blob for this Baseline Payload."},"workspace_baseline_id":{"type":"integer","format":"int32"}}}},"components/schemas/BillableUtilization":{"id":"components/schemas/BillableUtilization","kind":"json-schema","title":"Billable Utilization","data":{"title":"Billable Utilization","description":"Represents the billable utilization target for an account member. Each record has an effective date; the active billable utilization is the one with the most recent effective date.","type":"object","properties":{"account_membership_id":{"type":"string","description":"`account_membership_id` will only be included in the response if `account_membership` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time"},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"effective_date":{"type":"string","format":"date","description":"Date this billable utilization becomes active and the target goes into effect. Targets go into effect on midnight of the date selected (based on the Time Zone set in the Profile of the member)."},"target":{"type":"integer","format":"int32","description":"Percentage of logged hours that should be billable."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/BillingMilestone":{"id":"components/schemas/BillingMilestone","kind":"json-schema","title":"Billing Milestones","data":{"title":"Billing Milestones","description":"Billing milestones allow you to set up billable items in a project that are separate from the Task Tracker work and have invoicing rules.\nA set of billing milestones in a project is known as the [Billing Schedule](https://knowledge.kantata.com/hc/en-us/articles/35123275585947).","type":"object","properties":{"amount_in_cents":{"type":"integer","format":"int32","description":"The billing milestone amount, in the subunits of the currency (e.g. cents for USD)."},"billing_type":{"type":"string","description":"Determines how and when we bill clients for a particular billing milestone. Possible values are `fixed_date` and `upon_completion`."},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string","description":"The [ISO code](https://knowledge.kantata.com/hc/en-us/articles/360041576473-Supported-Currency-ISO-Codes-and-Formats) of the currency of the billing milestone."},"date_to_invoice":{"type":"string","format":"date","description":"When the billing milestone becomes invoiceable."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"invoice_id":{"type":"string","description":"The ID of the invoice associated with the billing milestone."},"invoice_ids":{"type":"array","items":{"type":"string"},"description":"`invoice_ids` will only be included in the response if `invoices` is in the list of included associations. See include section for usage."},"story_id":{"type":"string","description":"The ID of the story associated with the billing milestone. This field is required when the `billing_type` is set to `upon_completion`."},"title":{"type":"string","description":"The title of the billing milestone."},"updated_at":{"type":"string","format":"date-time"},"workspace_id":{"type":"string","description":"The ID of the workspace associated with the billing milestone."}}}},"components/schemas/BuyerParticipation":{"id":"components/schemas/BuyerParticipation","kind":"json-schema","title":"Participation","data":{"title":"Participation","description":"Participations in Kantata OX connect Users and Workspaces (projects). It includes\npermissions, cost rate, bill rate and role details for the participant in the workspace.","type":"object","properties":{"access_level":{"type":"string","description":"Access level for the user in the workspace. It must be one of \"admin\", \"financial\", \"time_logging\", \"collaboration\".\nVisible when the API user is an administrator on the project.\n\nOnly returned when requested through the optional_fields param."},"active_role_ids":{"type":"array","items":{"type":"string"},"description":"`active_role_ids` will only be included in the response if `active_roles` is in the list of included associations. See include section for usage."},"allocated_workspace_minutes":{"type":"integer","format":"int32","description":"The allocated minutes for the participant scoped to this project.\nVisible when the API user is a reports viewer on the project's account.."},"can_edit":{"type":"boolean","description":"Whether the participant has edit permissions to the project.\nVisible when the API user is an administrator on the project."},"can_edit_expense":{"type":"boolean","description":"Whether the participant can edit expenses in the project.\nVisible when the API user is an administrator on the project."},"can_edit_time":{"type":"boolean","description":"Whether the participant can edit time in the project.\nVisible when the API user is an administrator on the project."},"can_invite":{"type":"boolean","description":"Whether the participant can invite others to the project."},"can_post":{"type":"boolean","description":"Whether the participant can post in the project.\nVisible when the API user is an administrator on the project."},"can_schedule_team_hours":{"type":"boolean","description":"Whether the participant can schedule hours for team members.\nOnly returned when requested through the optional_fields param."},"can_schedule_their_hours":{"type":"boolean","description":"Whether the participant can schedule their hours.\nOnly returned when requested through the optional_fields param."},"cost_in_cents":{"type":"integer","format":"int32","description":"The cost (in cents) for the participant for this this project.\nVisible when the API user is an administrator and a consultant on the project.."},"created_at":{"type":"string","format":"date-time"},"default_rate_in_cents":{"type":"integer","format":"int32","description":"The default rate (in cents) for the participant for this project.\nVisible when the API user is a consultant on the project and has financial access on the project."},"estimated_workspace_minutes":{"type":"integer","format":"int32","description":"The estimated minutes for the participant scoped to this project.\nVisible when the API user is a reports viewer on the project's account.."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"is_foreign_participant":{"type":"boolean","description":"Whether the participant is part of the project's account.\nOnly returned when requested through the optional_fields param."},"is_team_lead":{"type":"boolean","description":"Whether the participant is a team lead in the project."},"permissions_label":{"type":"string","description":"Whether the user has an edit permission, a view only permission, or a view permission with additional access. Possible values are `edit`, `view_only`, or `view_with_custom`.\nVisible when the API user is an administrator on the project.\n\nOnly returned when requested through the optional_fields param."},"primary_role_id":{"type":"string","description":"`primary_role_id` will only be included in the response if `primary_role` is in the list of included associations. See include section for usage."},"rate_in_cents":{"type":"integer","format":"int32","description":"The rate (in cents) for the participant for this project.\nVisible when the API user is a consultant on the project and has financial access on the project."},"role":{"type":"string","description":"The role for the participant."},"show_as_read_only":{"type":"boolean","description":"Whether the API user can only read the project."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."},"workspace_resource_ids":{"type":"array","items":{"type":"string"},"description":"`workspace_resource_ids` will only be included in the response if `workspace_resources` is in the list of included associations. See include section for usage."},"workspace_role_id":{"type":"string","description":"`workspace_role_id` will only be included in the response if `workspace_role` is in the list of included associations. See include section for usage."}}}},"components/schemas/ChangeOrder":{"id":"components/schemas/ChangeOrder","kind":"json-schema","title":"Change Order","data":{"title":"Change Order","type":"object"}},"components/schemas/ClientInvoiceDefault":{"id":"components/schemas/ClientInvoiceDefault","kind":"json-schema","title":"Client Invoice Defaults","data":{"title":"Client Invoice Defaults","description":"Represents the default configuration for presenting invoices to clients.","type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time that the invoice default was created."},"expense_rollup_type":{"type":"integer","format":"int32","description":"Options for how expenses are formatted on an invoice. These options include 'Detailed' and 'Grouped'. They are represented by the numbers 0 and 1, respectively."},"rich_text":{"type":"string","description":"Default rich text shown as additional details on the invoice."},"show_creators":{"type":"boolean","description":"Whether the name of the person who created the entry should be shown."},"show_dates":{"type":"boolean","description":"Whether dates for items on the invoice should be shown."},"show_hours":{"type":"boolean","description":"Whether hours logged on a time entry on the invoice should be shown."},"show_notes":{"type":"boolean","description":"Whether notes for items on the invoice should be shown."},"show_project_names":{"type":"boolean","description":"Whether project names should be shown on the invoice."},"show_rates":{"type":"boolean","description":"Whether the rate for the item should be shown."},"show_roles":{"type":"boolean","description":"Whether the role of the person who created the item should be shown."},"show_subtotals":{"type":"boolean","description":"Whether subtotals should be shown for time entries on the invoice."},"show_task_names":{"type":"boolean","description":"Whether task names should be shown for invoice items."},"show_tax":{"type":"boolean","description":"Whether the item's taxable amount should be shown."},"time_rollup_type":{"type":"integer","format":"int32","description":"Options for how time is formatted on an invoice. These options include 'Detailed', 'Grouped by task', and 'Grouped by person, then task'. They are represented by the numbers 0, 1, and 2, respectively."},"updated_at":{"type":"string","format":"date-time","description":"The date and time that the invoice default was last updated."}}}},"components/schemas/Column":{"id":"components/schemas/Column","kind":"json-schema","title":"Column","data":{"title":"Column","type":"object","properties":{"filters":{"type":"string","description":"The saved filters for the column."},"name":{"type":"string","description":"The name of the column."}}}},"components/schemas/CostRate":{"id":"components/schemas/CostRate","kind":"json-schema","title":"Cost Rate","data":{"title":"Cost Rate","description":"A Cost Rate represents the hourly cost of an account member, specified in a specific currency. A Cost Rate with the same currency\nas the account default currency is called the `default cost rate`. This data can only be accessed by including\nit when querying Account Membership.","type":"object","properties":{"account_membership_id":{"type":"integer","format":"int32","description":"The ID of the associated account membership."},"amount_in_subunits":{"type":"integer","format":"int32","description":"The amount of the cost rate in the subunits of the currency (i.e. cents for US Dollars)."},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string","description":"The ISO code of the cost rate currency."},"in_use":{"type":"boolean","description":"Indicates whether the account member associated with the cost rate is participating in a workspace\non the account that uses the same currency as the cost rate."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/CustomField":{"id":"components/schemas/CustomField","kind":"json-schema","title":"Custom Field","data":{"title":"Custom Field","description":"The [Custom Fields](https://mavenlink.zendesk.com/hc/en-us/articles/202924760-Custom-Fields-Overview-#arrange) object allows you to\nview, create, update, and delete extra fields for additional Estimate, Project, Group, Resource, Task, and User information.\nIf Custom Fields represent the fields themselves, [Custom Field Values](/tag/Custom-Field-Values)\nrepresent the values in/of those fields.","type":"object","properties":{"choice_ids":{"type":"array","items":{"type":"string"},"description":"`choice_ids` will only be included in the response if `choices` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time"},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"custom_field_set_id":{"type":"string","description":"`custom_field_set_id` will only be included in the response if `custom_field_set` is in the list of included associations. See include section for usage."},"default_text":{"type":"string","description":"The message in an empty custom field, before a `string`, `date`, `number`, or `currency` value is entered in.\nThis only appears in the UI.\nVisible when whether the custom field is an input field.."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"name":{"type":"string","description":"The name of the custom field."},"read_access":{"type":"integer","format":"int32","description":"The `read_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to view a custom field and its value.\n* `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific objects,\nso their minimum permissions are set at the [project level](https://mavenlink.zendesk.com/hc/en-us/articles/115002779293-Project-Permissions):\n - `project_collaboration` (default)\n - `time_logging`\n - `financial`\n - `project_admin`\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators\nare able to view all Project, Resource, and Task custom fields and values across the account,\nregardless of project participation or `read_access` settings.\n* `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide objects,\nso their minimum permissions are set at the [account level](https://mavenlink.zendesk.com/hc/en-us/articles/203041364):\n - `account_collaboration`\n - `project_creator`\n - `project_lead`\n - `reports_viewer`\n - `reports_viewer_with_cost`\n - `account_admin` (default)."},"unique_constraint":{"type":"boolean","description":"Indicates whether a custom field value must be unique across Estimates, Projects, Groups, Resources, Tasks, or Users.\nThis is set to `false` by default.\n\nDoes not apply to Custom Fields with choices.\nVisible when whether the custom field is an input field.."},"updated_at":{"type":"string","format":"date-time"},"value_type":{"type":"string","description":"The format of the [custom field's value](/tag/Custom-Field-Values):\n | Value Type | Format | Sample |\n | -------------------- |:----------------------------------------:| --------------:|\n | `string` | `` | `\"foo\"` |\n | `date` | `` | `\"2014-02-25\"` |\n | `number` | `` | `13` |\n | `currency` | `[, ]`| `[998, \"USD\"]` |\n | `single` and `multi` | `[]` | `[1, 2, 4]` |\n\nThis is set to `string`, by default."},"write_access":{"type":"integer","format":"int32","description":"The permission level required for a user to create, update, or delete a custom field's value."}}}},"components/schemas/CustomFieldChoice":{"id":"components/schemas/CustomFieldChoice","kind":"json-schema","title":"Custom Field Choice","data":{"title":"Custom Field Choice","description":"Custom Field Choices are possible values for `single` and `multi` type custom fields.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"custom_field_id":{"type":"string","description":"`custom_field_id` will only be included in the response if `custom_field` is in the list of included associations. See include section for usage."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"label":{"type":"string"},"position":{"type":"integer","format":"int32"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/CustomFieldSet":{"id":"components/schemas/CustomFieldSet","kind":"json-schema","title":"Custom Field Set","data":{"title":"Custom Field Set","description":"Custom Field Sets contain custom fields and definitions of each fields' subject type. The supported\nsubjects are currently Estimate, Project, Project Group, Resource, Task, and User.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"custom_field_ids":{"type":"array","items":{"type":"string"},"description":"`custom_field_ids` will only be included in the response if `custom_fields` is in the list of included associations. See include section for usage."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"name":{"type":"string"},"subject_type":{"type":"string","description":"The type of objects contained in the custom field set. The supported subjects are currently\n*Workspace*, *Story*, *User*, and *WorkspaceGroup*."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/CustomFieldValue":{"id":"components/schemas/CustomFieldValue","kind":"json-schema","title":"Custom Field Value","data":{"title":"Custom Field Value","description":"If [Custom Fields](/tag/Custom-Fields) represent the fields themselves,\nCustom Field Values represent the values in/of those fields.","type":"object","properties":{"account_id":{"type":"integer","format":"int32","description":"The ID of the account the Custom Field Value is in."},"can_edit":{"type":"boolean","description":"Whether the Custom Field Value can be edited by the requester."},"created_at":{"type":"string","format":"date-time"},"custom_field_id":{"type":"string","description":"`custom_field_id` will only be included in the response if `custom_field` is in the list of included associations. See include section for usage."},"custom_field_name":{"type":"string","description":"The name of the Custom Field."},"display_value":{"type":"string","description":"The Custom Field Values, but in more understandable formats:\n* For Custom Fields with values that are selected choices, the labels on those choices are returned.\n* For Custom Fields with currency values, the amount with the currency symbol ($100) is returned.\n* All other values are converted into a string."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"selected_choice_ids":{"type":"array","items":{"type":"string"},"description":"`selected_choice_ids` will only be included in the response if `selected_choices` is in the list of included associations. See include section for usage."},"setter_id":{"type":"string","description":"`setter_id` will only be included in the response if `setter` is in the list of included associations. See include section for usage."},"subject_id":{"type":"integer","format":"int32","description":"The ID of the Estimate, Project, Group, Resource, Task, or User the custom field is for."},"subject_ref":{"type":"object","description":"`subject_ref` will only be included in the response if `subject` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"subject_type":{"type":"string","description":"The set of Custom Fields that values are returned for:\n* `Estimate`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`\n* `Story` (Task)\n* `User`."},"type":{"type":"string","description":"Potential formats of values:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |."},"updated_at":{"type":"string","format":"date-time"},"value":{"type":"string","description":"The value created or updated for the specified custom field.\n\nValues can be created or updated in these formats:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |\n\n##### Note:\nThe `read_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to view a custom field and its value.\n* `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific objects,\nso their minimum permissions are set at the [project level](https://mavenlink.zendesk.com/hc/en-us/articles/115002779293-Project-Permissions):\n- `project_collaboration` (default)\n- `time_logging`\n- `financial`\n- `project_admin`\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators\nare able to view all Project, Resource, and Task custom fields and values across the account,\nregardless of project participation or `read_access` settings.\n* `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide objects,\nso their minimum permissions are set at the [account level](https://mavenlink.zendesk.com/hc/en-us/articles/203041364):\n- `account_collaboration`\n- `project_creator`\n- `project_lead`\n- `reports_viewer`\n- `reports_viewer_with_cost`\n- `account_admin` (default)."}}}},"components/schemas/Department":{"id":"components/schemas/Department","kind":"json-schema","title":"Organization","data":{"title":"Organization","description":"An Organization allows you to structure and group your projects and account members by\ndepartments and geographies.","type":"object","properties":{"ancestor_ids":{"type":"array","items":{"type":"string"},"description":"The ids of all ancestors of the organization."},"created_at":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The unique name of the organization."},"parent_id":{"type":"string","description":"The id of the parent organization."},"type":{"type":"string","description":"The type of the organization, either 'Geography' or 'Department'."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Estimate":{"id":"components/schemas/Estimate","kind":"json-schema","title":"Estimate","data":{"title":"Estimate","description":"An Estimate represents a potential project. Estimates allow you to plan out a project's budget, resources,\nand allocations through associated estimate scenarios.","type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The time the estimate was created."},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"currency":{"type":"string","description":"The currency of the estimate, used in all associated estimate scenarios."},"custom_field_value_ids":{"type":"array","items":{"type":"string"},"description":"`custom_field_value_ids` will only be included in the response if `custom_field_values` is in the list of included associations. See include section for usage."},"description":{"type":"string","description":"The description of the estimate."},"estimate_scenario_ids":{"type":"array","items":{"type":"string"},"description":"`estimate_scenario_ids` will only be included in the response if `estimate_scenarios` is in the list of included associations. See include section for usage."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"is_locked":{"type":"boolean","description":"Whether a project has been created from the estimate. If so, the estimate can no longer be updated."},"name":{"type":"string","description":"The name of the estimate."},"updated_at":{"type":"string","format":"date-time"},"workspace_group_id":{"type":"string","description":"`workspace_group_id` will only be included in the response if `workspace_group` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/EstimateScenario":{"id":"components/schemas/EstimateScenario","kind":"json-schema","title":"Estimate Scenario","data":{"title":"Estimate Scenario","description":"An Estimate Scenario represents a possible project configuration. It includes a rate card, budget, and\nassociated resources and allocations.","type":"object","properties":{"budget_in_cents":{"type":"integer","format":"int32","description":"The maximum budget, in cents, available for the project."},"created_at":{"type":"string","format":"date-time"},"estimate_id":{"type":"integer","format":"int32","description":"The ID of the estimate for the scenario."},"estimate_scenario_resource_ids":{"type":"array","items":{"type":"string"},"description":"`estimate_scenario_resource_ids` will only be included in the response if `estimate_scenario_resources` is in the list of included associations. See include section for usage."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"name":{"type":"string","description":"The name of the estimate scenario."},"rate_card_id":{"type":"string","description":"`rate_card_id` will only be included in the response if `rate_card` is in the list of included associations. See include section for usage."},"start_date":{"type":"string","format":"date-time","description":"The estimated date when the project will start."},"target_margin_percent":{"type":"integer","format":"int32","description":"The target profit margin, in percentage, for the project."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/EstimateScenarioResource":{"id":"components/schemas/EstimateScenarioResource","kind":"json-schema","title":"Estimate Scenario Resource","data":{"title":"Estimate Scenario Resource","description":"An Estimate Scenario Resource is an unnamed resource in an estimate scenario.","type":"object","properties":{"allocation_id":{"type":"string","description":"`allocation_id` will only be included in the response if `allocation` is in the list of included associations. See include section for usage."},"bill_rate":{"type":"integer","format":"int32","description":"The bill rate, in cents, of the estimate scenario resource.\nWhen the estimate is unlocked, this is the average bill rate of all active account members in the\nscenario resource's geography, whose default role matches the role of the scenario resource.\nWhen the estimate is locked, this the cached value of the average bill rate when the estimate was locked."},"cost_rate":{"type":"integer","format":"int32","description":"The cost rate, in cents, of the estimate scenario resource.\nWhen the estimate is unlocked, this is the average cost rate of all active account members in the\nscenario resource's geography, whose default role matches the role of the scenario resource.\nWhen the estimate is locked, this the cached value of the average cost rate when the estimate was locked."},"created_at":{"type":"string","format":"date-time"},"display_label":{"type":"string","description":"User facing Identifier for the Resource."},"estimate_scenario_id":{"type":"integer","format":"int32","description":"Id of the Estimate Scenario that the Resource belongs to."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"geography_id":{"type":"string","description":"`geography_id` will only be included in the response if `geography` is in the list of included associations. See include section for usage."},"label":{"type":"string"},"organization_membership_id":{"type":"string","description":"`organization_membership_id` will only be included in the response if `organization_membership` is in the list of included associations. See include section for usage."},"role_id":{"type":"string","description":"`role_id` will only be included in the response if `role` is in the list of included associations. See include section for usage."},"role_name":{"type":"string","description":"Name of the Resource's role if any."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."}}}},"components/schemas/EstimateScenarioResourceAllocation":{"id":"components/schemas/EstimateScenarioResourceAllocation","kind":"json-schema","title":"Estimate Scenario Resource Allocation","data":{"title":"Estimate Scenario Resource Allocation","description":"Estimate Scenario Resource Allocations contain time-related data for scenario resources—used\nfor calculating estimated cost and scheduled hours.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"duration_days":{"type":"integer","format":"int32","description":"The total number of business days an scenario resource is expected to work on the project."},"percent_allocated":{"type":"number","format":"float","description":"The percentage of available hours the scenario resource will work on the project."},"relative_start_day":{"type":"integer","format":"int32","description":"The number of business days, after the estimate scenario's start date, that an scenario resource\nwill begin working on the project."},"resource_id":{"type":"string","description":"`resource_id` will only be included in the response if `resource` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Expense":{"id":"components/schemas/Expense","kind":"json-schema","title":"Expense","data":{"title":"Expense","description":"Expenses are non-time related costs incurred in a project. Once created, expenses can\nbe included in generated invoices.","type":"object","properties":{"active_submission_id":{"type":"string","description":"`active_submission_id` will only be included in the response if `active_submission` is in the list of included associations. See include section for usage."},"amount_in_cents":{"type":"integer","format":"int32","description":"The amount, in cents, of the expense."},"category":{"type":"string","description":"The category of the expense (can be any string). Built-in categories are:\nTravel, Mileage, Lodging, Food, Entertainment, and Other."},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string","description":"The currency of the expense."},"currency_base_unit":{"type":"integer","format":"int32","description":"The number of the units in the `amount_as_cents` attribute that are required to make up a single unit of the `currency`."},"currency_symbol":{"type":"string","description":"The symbol that represents the currency of the expense."},"date":{"type":"string","format":"date","description":"The date the expense was incurred."},"expense_budget_id":{"type":"string","description":"`expense_budget_id` will only be included in the response if `expense_budget` is in the list of included associations. See include section for usage."},"expense_category_id":{"type":"string","description":"`expense_category_id` will only be included in the response if `expense_category` is in the list of included associations. See include section for usage."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"foreign_exchange_amount":{"type":"object","description":"The currency conversion data for a converted expense.","properties":{"date":{"type":"string","format":"date-time","description":"The date the expense was converted."},"rate":{"type":"number","format":"float","description":"The exchange rate used to convert the expense."},"source_currency":{"type":"string","description":"The [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473-Supported-Currency-ISO-Codes) of the foreign currency in which the expense was incurred."},"source_value":{"type":"number","format":"float","description":"The amount of the expense, in foreign currency units."}}},"is_billable":{"type":"boolean","description":"Whether this is a billable expense."},"is_invoiced":{"type":"boolean","description":"Whether this expense has been included on an invoice."},"notes":{"type":"string","description":"All notes that have been added to the expense."},"receipt_id":{"type":"string","description":"`receipt_id` will only be included in the response if `receipt` is in the list of included associations. See include section for usage."},"recent_submission_id":{"type":"string","description":"`recent_submission_id` will only be included in the response if `recent_submission` is in the list of included associations. See include section for usage."},"reimbursable":{"type":"boolean","description":"Whether this expense is reimbursable to the creator or to a vendor."},"role_id":{"type":"string","description":"`role_id` will only be included in the response if `role` is in the list of included associations. See include section for usage."},"story_id":{"type":"string","description":"`story_id` will only be included in the response if `story` is in the list of included associations. See include section for usage."},"taxable":{"type":"boolean","description":"Whether this expense is marked as taxable when invoiced."},"updated_at":{"type":"string","format":"date-time"},"user_can_edit":{"type":"boolean","description":"Whether the viewing user can edit this expense.\nOnly returned when requested through the optional_fields param."},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"vendor_id":{"type":"string","description":"`vendor_id` will only be included in the response if `vendor` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/ExpenseBudget":{"id":"components/schemas/ExpenseBudget","kind":"json-schema","title":"Expense Budgets","data":{"title":"Expense Budgets","description":"Expense budgets allow you to plan for non-labor expenses.","type":"object","properties":{"billable":{"type":"boolean","description":"Whether the expense will be billed to the client."},"burns_budget":{"type":"boolean","description":"Whether the expense budget impacts the project margin."},"cost_per_unit_in_subunits":{"type":"integer","format":"int32","description":"The cost, in the subunits of the currency (e.g. cents for USD)."},"description":{"type":"string","description":"The description of the expense budget."},"expected_by":{"type":"string","format":"date","description":"When the expenses are expected to be logged by."},"expense_ids":{"type":"array","items":{"type":"string"},"description":"`expense_ids` will only be included in the response if `expenses` is in the list of included associations. See include section for usage."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"fixed_fee":{"type":"boolean","description":"Whether the expense will be billed as a fixed cost."},"fixed_fee_item_ids":{"type":"array","items":{"type":"string"},"description":"`fixed_fee_item_ids` will only be included in the response if `fixed_fee_items` is in the list of included associations. See include section for usage."},"markup_per_unit_in_subunits":{"type":"integer","format":"int32","description":"When the `markup_type` is `flat_fee`, this is the markup per unit, in the subunits of the currency\n(e.g. cents for USD). This is multiplied by the `quantity` and added to the total cost to produce\nthe total fees."},"markup_percentage":{"type":"number","format":"float","description":"When the `markup_type` is set to `percentage`, this is the markup percentage.\nThis is multiplied by the total cost to produce the total markup,\nthen added to the total cost to produce the total fees."},"markup_type":{"type":"string","description":"The markup type. Possible values are `percentage` and `flat_fee`."},"quantity":{"type":"integer","format":"int32","description":"The number of units."},"story_id":{"type":"integer","format":"int32","description":"The ID of the associated story (task)."},"title":{"type":"string","description":"The name of the expense budget."},"workspace_id":{"type":"integer","format":"int32","description":"The ID of the workspace the expense budget belongs to."}}}},"components/schemas/ExpenseCategory":{"id":"components/schemas/ExpenseCategory","kind":"json-schema","title":"Expense Category","data":{"title":"Expense Category","description":"An Expense Category represents the type of expense that is being reported.\nExpense categories have no attributes and consist of just their name\nas a string. They can be changed by Account Administrators.","type":"object","properties":{"deleted_at":{"type":"string","format":"date-time","description":"The time when the expense category was deleted (if it has been deleted)."},"name":{"type":"string","description":"The name of the expense category."}}}},"components/schemas/ExpenseReportSubmission":{"id":"components/schemas/ExpenseReportSubmission","kind":"json-schema","title":"Expense Report Submission","data":{"title":"Expense Report Submission","description":"Expense report submissions contain a set of expense line items. These expenses must be approved through\nan expense report submission before they can be added to an invoice. All submission expenses must be in the \nsame workspace (project).","type":"object","properties":{"comment":{"type":"string","description":"Additional comments on the submission."},"created_at":{"type":"string","format":"date-time","description":"The date and time that the submission was created."},"currency":{"type":"string","description":"The currency of the submission."},"currency_base_unit":{"type":"integer","format":"int32","description":"The base unit of the submission's currency."},"currency_symbol":{"type":"string","description":"The symbol of the submission's currency."},"current_resolution_created_at_date":{"type":"string","format":"date-time","description":"The date and time that the submission's current resolution was created."},"current_resolution_creator_id":{"type":"integer","format":"int32","description":"The creator id on the submission's current resolution."},"current_resolution_description":{"type":"string","description":"The description on the submission's current resolution."},"expense_ids":{"type":"array","items":{"type":"string"},"description":"`expense_ids` will only be included in the response if `expenses` is in the list of included associations. See include section for usage."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"line_item_total_formatted":{"type":"string","description":"A formatted total of the line items (time entries or expenses) on the submission."},"line_item_total_in_cents":{"type":"integer","format":"int32","description":"A total in cents of the line items (time entries or expenses) on the submission."},"locked":{"type":"boolean","description":"Whether or not the submission can be changed."},"permissions":{"type":"object","properties":{"can_cancel_submission":{"type":"boolean","description":"Can the current user cancel the submission."},"can_approve_submission":{"type":"boolean","description":"Can the current user approve the submission."},"can_reject_submission":{"type":"boolean","description":"Can the current user reject the submission."},"can_resubmit_submission":{"type":"boolean","description":"Can the current user resubmit the submission."}}},"resolution_description":{"type":"string","description":"The description on the submission's current resolution."},"resolution_ids":{"type":"array","items":{"type":"string"},"description":"`resolution_ids` will only be included in the response if `resolutions` is in the list of included associations. See include section for usage."},"status":{"type":"string","description":"The current status of the submission ('approved', 'rejected', 'cancelled', 'pending')."},"title":{"type":"string","description":"The title of the submission."},"type":{"type":"string","description":"Either an ExpenseReportSubmission or a TimesheetSubmission."},"updated_at":{"type":"string","format":"date-time","description":"The date and time that the submission was last updated."},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/ExternalPayment":{"id":"components/schemas/ExternalPayment","kind":"json-schema","title":"External Payment","data":{"title":"External Payment","description":"An External Payment is a record within a workspace of a payment that happened outside of Kantata OX.","type":"object","properties":{"amount_in_cents":{"type":"integer","format":"int32","description":"The amount the payment was for, in cents."},"created_at":{"type":"string","format":"date-time","description":"The date and time the payment was created."},"invoice_id":{"type":"integer","format":"int32","description":"The id of the invoice, if any, for which the payment was created."},"message":{"type":"string","description":"The message that accompanied the payment."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the payment was last updated."},"user_id":{"type":"integer","format":"int32","description":"The id of the user who created the payment."},"workspace_id":{"type":"integer","format":"int32","description":"The id of the project in which the payment was created."}}}},"components/schemas/ExternalReference":{"id":"components/schemas/ExternalReference","kind":"json-schema","title":"External Reference","data":{"title":"External Reference","description":"External References allows users see which objects (one of `Assignment`, `BillingMilestone`, `CustomField`, `CustomFieldChoice`, `CustomFieldSet`, `CustomFieldValue`, `Estimate`, `EstimateScenario`, `EstimateScenarioResource`, `Expense`, `ExpenseBudget`, `Invoice`, `Participation`, `Post`, `RateCard`, `Role`, `Skill`, `StatusReport`, `Story`, `StoryAllocationDay`, `Submission`, `SurveyAnswer`, `SurveyQuestion`, `SurveyResponse`, `SurveyTemplate`, `TimeEntry`, `TimeOffEntry`, `User`, `Vendor`, `Workspace`, `WorkspaceAllocation`, `WorkspaceGroup`, or `WorkspaceResource`\nare synced with third party systems. This allows you to view the sync status of items in addition to the integration\nspecifics for a synced object.\n\nObjects that are synced with a third party system have external integration\nattributes that include the corresponding ID of the third party object with\nwhich it is synced, a link that allows you to view the object in the third\nparty system, the status of the external object in the external system,\nthe status of the sync, and a link to exceptions.","type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time the reference was created."},"external_link":{"type":"string","description":"A URL that links to either the external object or event."},"external_message":{"type":"string","description":"An optional message about the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"last_synced_at":{"type":"string","format":"date-time"},"locked":{"type":"boolean","description":"An optional field, indicating whether the subject should be locked. To prevent changes to the\nobject in Kantata OX, set this to true. This currently only applies to expense report rejections."},"service_model":{"type":"string","description":"The type of the external object to which this reference belongs."},"service_model_ref":{"type":"string","description":"The ID of the external object to which this reference belongs."},"service_name":{"type":"string","description":"The provider name of the integration."},"status":{"type":"string","description":"The status of the integration. Options are 'pending', 'successful', or 'failed'."},"subject_id":{"type":"integer","format":"int32","description":"The ID of the Kantata OX object to which this external reference belongs."},"subject_ref":{"type":"object","description":"`subject_ref` will only be included in the response if `subject` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"subject_type":{"type":"string","description":"The type of Kantata OX object to which this external reference belongs.\nOne of `Assignment`, `BillingMilestone`, `CustomField`, `CustomFieldChoice`, `CustomFieldSet`, `CustomFieldValue`, `Estimate`, `EstimateScenario`, `EstimateScenarioResource`, `Expense`, `ExpenseBudget`, `Invoice`, `Participation`, `Post`, `RateCard`, `Role`, `Skill`, `StatusReport`, `Story`, `StoryAllocationDay`, `Submission`, `SurveyAnswer`, `SurveyQuestion`, `SurveyResponse`, `SurveyTemplate`, `TimeEntry`, `TimeOffEntry`, `User`, `Vendor`, `Workspace`, `WorkspaceAllocation`, `WorkspaceGroup`, or `WorkspaceResource`."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the reference was last updated."}}}},"components/schemas/FixedFeeItem":{"id":"components/schemas/FixedFeeItem","kind":"json-schema","title":"Fixed Fee Item","data":{"title":"Fixed Fee Item","type":"object","properties":{"amount_in_cents":{"type":"integer","format":"int32"},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"notes":{"type":"string"},"story_id":{"type":"integer","format":"int32"},"taxable":{"type":"boolean"},"workspace_id":{"type":"integer","format":"int32"}}}},"components/schemas/Geography":{"id":"components/schemas/Geography","kind":"json-schema","title":"Organization","data":{"title":"Organization","description":"An Organization allows you to structure and group your projects and account members by\ndepartments and geographies.","type":"object","properties":{"ancestor_ids":{"type":"array","items":{"type":"string"},"description":"The ids of all ancestors of the organization."},"created_at":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The unique name of the organization."},"parent_id":{"type":"string","description":"The id of the parent organization."},"type":{"type":"string","description":"The type of the organization, either 'Geography' or 'Department'."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Holiday":{"id":"components/schemas/Holiday","kind":"json-schema","title":"Holiday","data":{"title":"Holiday","description":"A holiday is a day (or range of days) representing company-wide time off. Holidays are associated with a calendar for scheduling purposes.\".","type":"object","properties":{"calendar_names_list":{"type":"string","description":"A comma separated list of calendar names to which the holiday belongs.\nOnly returned when requested through the optional_fields param."},"end_date":{"type":"string","format":"date","description":"The date the holiday ends."},"holiday_calendar_association_ids":{"type":"array","items":{"type":"string"},"description":"`holiday_calendar_association_ids` will only be included in the response if `holiday_calendar_associations` is in the list of included associations. See include section for usage."},"name":{"type":"string","description":"The name of the holiday."},"paid":{"type":"boolean","description":"Whether the holiday is paid."},"start_date":{"type":"string","format":"date","description":"The date the holiday begins."},"total_hours":{"type":"integer","format":"int32","description":"The number of workweek hours that the holiday includes."}}}},"components/schemas/HolidayCalendar":{"id":"components/schemas/HolidayCalendar","kind":"json-schema","title":"Holiday Calendar","data":{"title":"Holiday Calendar","description":"A Holiday Calendar defines the days in which account members are unavailable to work due to company-wide days off.","type":"object","properties":{"default":{"type":"boolean","description":"Whether the holiday calendar is the account default."},"name":{"type":"string","description":"The name of the holiday calendar."}}}},"components/schemas/HolidayCalendarAssociation":{"id":"components/schemas/HolidayCalendarAssociation","kind":"json-schema","title":"Holiday Calendar Association","data":{"title":"Holiday Calendar Association","description":"A Holiday Calendar Association represents the relationship between Holiday objects and Holiday Calendar objects.\nA Holiday can be associated with several different Holiday Calendars.\nTo associate a Holiday with a Holiday Calendar create a Holiday Calendar Assocation.","type":"object","properties":{"holiday_calendar_id":{"type":"string","description":"`holiday_calendar_id` will only be included in the response if `holiday_calendar` is in the list of included associations. See include section for usage."},"holiday_calendar_name":{"type":"string","description":"Returns the name of the associated Holiday Calendar."},"holiday_id":{"type":"string","description":"`holiday_id` will only be included in the response if `holiday` is in the list of included associations. See include section for usage."},"holiday_name":{"type":"string","description":"Returns the name of the associated Holiday."}}}},"components/schemas/HolidayCalendarMembership":{"id":"components/schemas/HolidayCalendarMembership","kind":"json-schema","title":"Holiday Calendar Membership","data":{"title":"Holiday Calendar Membership","description":"A Holiday Calendar Membership represents a calendar which has been applied to a user.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date","description":"When the calendar stops applying."},"holiday_calendar_id":{"type":"string","description":"`holiday_calendar_id` will only be included in the response if `holiday_calendar` is in the list of included associations. See include section for usage."},"in_use":{"type":"boolean","description":"Whether the calendar is currently active for the user."},"start_date":{"type":"string","format":"date","description":"When the calendar begins to apply."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"integer","format":"int32","description":"The user associated with the calendar."}}}},"components/schemas/InsightsAccessGroupMembership":{"id":"components/schemas/InsightsAccessGroupMembership","kind":"json-schema","title":"Insights Access Group Membership","data":{"title":"Insights Access Group Membership","description":"[Insights Access Groups](https://mavenlink.zendesk.com/hc/en-us/articles/115002115073) allow you to manage classic Insights access for users. An Insights Access \n Group Membership represents the connection of a user to an Insights Access Group.","type":"object","properties":{"account_permission":{"type":"string","description":"The account level permission of the associated user.\nOnly returned when requested through the optional_fields param."},"can_edit":{"type":"boolean","description":"Whether the user can create and edit custom classic Insights dashboards and reports. \n\n**Warning**: Users with `can_edit` permission have access to *all* account data via Insights."},"created_at":{"type":"string","format":"date-time","description":"When the Insights Access Group Membership was created (i.e. when the user was added to the Insights Access Group)."},"insights_access_group_id":{"type":"integer","format":"int32","description":"The ID of the associated Insights Access Group."},"insights_access_group_name":{"type":"string","description":"The name of the associated Insights Access Group."},"updated_at":{"type":"string","format":"date-time","description":"When the Insights Access Group Membership was updated."},"user_id":{"type":"integer","format":"int32","description":"The ID of the associated user."},"user_name":{"type":"string","description":"The name of the associated user.\nOnly returned when requested through the optional_fields param."}}}},"components/schemas/Invoice":{"id":"components/schemas/Invoice","kind":"json-schema","title":"Invoice","data":{"title":"Invoice","description":"An Invoice is defined as a list of costs incurred during a Kantata OX project, which are billable to an end user.","type":"object","properties":{"additional_item_ids":{"type":"array","items":{"type":"string"},"description":"`additional_item_ids` will only be included in the response if `additional_items` is in the list of included associations. See include section for usage."},"balance_in_cents":{"type":"integer","format":"int32","description":"The balance, in cents, of the invoice."},"billing_milestone_ids":{"type":"array","items":{"type":"string"},"description":"`billing_milestone_ids` will only be included in the response if `billing_milestones` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time","description":"The date the invoice was recorded in Kantata OX, in YY-MM-DD[T]HH:MM:SS-TIMEZONE format."},"currency":{"type":"string","description":"The currency being used for the invoice."},"currency_base_unit":{"type":"integer","format":"int32","description":"The number of the units in the `balance_in_cents` attribute that are required to make up a single unit of the `currency`."},"currency_symbol":{"type":"string","description":"The symbol that represents the currency being used for the invoice."},"draft":{"type":"boolean","description":"Whether or not the invoice is a draft."},"due_date":{"type":"string","format":"date","description":"The date the invoice is due, in YYYY-MM-DD format."},"expense_ids":{"type":"array","items":{"type":"string"},"description":"`expense_ids` will only be included in the response if `expenses` is in the list of included associations. See include section for usage."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"fixed_fee_item_ids":{"type":"array","items":{"type":"string"},"description":"`fixed_fee_item_ids` will only be included in the response if `fixed_fee_items` is in the list of included associations. See include section for usage."},"invoice_date":{"type":"string","format":"date","description":"The date the invoice was incurred, in YYYY-MM-DD format."},"message":{"type":"string","description":"Any notes added to the invoice."},"payment_schedule":{"type":"integer","format":"int32","description":"The number of days within which the total amount of the invoice is expected to be paid. For example, use `30` for a Net 30 payment schedule. See https://en.wikipedia.org/wiki/Net_D."},"project_code":{"type":"string","description":"The invoice project code."},"purchase_order":{"type":"string","description":"The invoice purchase order."},"recipient_id":{"type":"string","description":"`recipient_id` will only be included in the response if `recipient` is in the list of included associations. See include section for usage."},"status":{"type":"string","description":"The current status of the invoice ('new', 'cancelled', 'accepted payment')."},"tax_rate":{"type":"number","format":"float","description":"The tax rate percentage that is applied to the invoice total."},"time_entry_ids":{"type":"array","items":{"type":"string"},"description":"`time_entry_ids` will only be included in the response if `time_entries` is in the list of included associations. See include section for usage."},"title":{"type":"string","description":"The auto-generated invoice title. The format is `Invoice #[user_invoice_number]` or `Draft Invoice #[user_invoice_number]`."},"updated_at":{"type":"string","format":"date-time","description":"The date the invoice was last updated, in YY-MM-DD[T]HH:MM:SS-TIMEZONE format."},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"user_invoice_number":{"type":"integer","format":"int32","description":"The invoice number."},"user_invoice_title":{"type":"string","description":"The user-entered title of the invoice."},"workspace_ids":{"type":"array","items":{"type":"string"},"description":"`workspace_ids` will only be included in the response if `workspaces` is in the list of included associations. See include section for usage."}}}},"components/schemas/IpRestriction":{"id":"components/schemas/IpRestriction","kind":"json-schema","title":"IP Restriction","data":{"title":"IP Restriction","description":"Each IP Restriction represents the account permission levels that can access Kantata OX\nfor a range of IP Addresses.","type":"object","properties":{"administrator":{"type":"boolean","description":"Access allowed in this IpRestriction rule applies to users with an account role of administrator."},"collaborator":{"type":"boolean","description":"Access allowed in this IpRestriction rule applies to users with an account role of collaborator."},"created_at":{"type":"string","format":"date-time"},"ip_address_cidr":{"type":"string","description":"Address range represented in Classless Inter-Domain Routing notation."},"is_default":{"type":"boolean","description":"Specifies if this record is the default whitelist that is created when IP Restrictions are enabled."},"name":{"type":"string","description":"User-defined display name for the whitelist range (e.g. Salt Lake Office)."},"project_creator":{"type":"boolean","description":"Access allowed in this IpRestriction rule applies to users with an account role of project creator."},"project_lead":{"type":"boolean","description":"Access allowed in this IpRestriction rule applies to users with an account role of project lead."},"punch_clock":{"type":"boolean","description":"Access allowed in this IpRestriction rule applies to users with an account role of punch clock."},"reports_viewer":{"type":"boolean","description":"Access allowed in this IpRestriction rule applies to users with an account role of reports viewer."},"reports_viewer_with_cost":{"type":"boolean","description":"Access allowed in this IpRestriction rule applies to users with an account role of reports viewer with cost."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/LineItemLock":{"id":"components/schemas/LineItemLock","kind":"json-schema","title":"Line Item Lock","data":{"title":"Line Item Lock","description":"LineItemLocks provide a way for you to lock time in the past so that previous time entries \ncannot be edited or updated and new time entries cannot be created before the selected lock date.\n\nLine Items can be locked to any Saturday in the past on a per account basis.\n\nKeep in mind that this feature does not lock the ability to invoice approved time entries,\nnor does it lock the submission or approval of expenses.","type":"object","properties":{"account_id":{"type":"integer","format":"int32","description":"The account for which line items will be locked."},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"locked_to":{"type":"string","format":"date","description":"The date before which you would like line items to be locked."}}}},"components/schemas/MavenParticipation":{"id":"components/schemas/MavenParticipation","kind":"json-schema","title":"Participation","data":{"title":"Participation","description":"Participations in Kantata OX connect Users and Workspaces (projects). It includes\npermissions, cost rate, bill rate and role details for the participant in the workspace.","type":"object","properties":{"access_level":{"type":"string","description":"Access level for the user in the workspace. It must be one of \"admin\", \"financial\", \"time_logging\", \"collaboration\".\nVisible when the API user is an administrator on the project.\n\nOnly returned when requested through the optional_fields param."},"active_role_ids":{"type":"array","items":{"type":"string"},"description":"`active_role_ids` will only be included in the response if `active_roles` is in the list of included associations. See include section for usage."},"allocated_workspace_minutes":{"type":"integer","format":"int32","description":"The allocated minutes for the participant scoped to this project.\nVisible when the API user is a reports viewer on the project's account.."},"can_edit":{"type":"boolean","description":"Whether the participant has edit permissions to the project.\nVisible when the API user is an administrator on the project."},"can_edit_expense":{"type":"boolean","description":"Whether the participant can edit expenses in the project.\nVisible when the API user is an administrator on the project."},"can_edit_time":{"type":"boolean","description":"Whether the participant can edit time in the project.\nVisible when the API user is an administrator on the project."},"can_invite":{"type":"boolean","description":"Whether the participant can invite others to the project."},"can_post":{"type":"boolean","description":"Whether the participant can post in the project.\nVisible when the API user is an administrator on the project."},"can_schedule_team_hours":{"type":"boolean","description":"Whether the participant can schedule hours for team members.\nOnly returned when requested through the optional_fields param."},"can_schedule_their_hours":{"type":"boolean","description":"Whether the participant can schedule their hours.\nOnly returned when requested through the optional_fields param."},"cost_in_cents":{"type":"integer","format":"int32","description":"The cost (in cents) for the participant for this this project.\nVisible when the API user is an administrator and a consultant on the project.."},"created_at":{"type":"string","format":"date-time"},"default_rate_in_cents":{"type":"integer","format":"int32","description":"The default rate (in cents) for the participant for this project.\nVisible when the API user is a consultant on the project and has financial access on the project."},"estimated_workspace_minutes":{"type":"integer","format":"int32","description":"The estimated minutes for the participant scoped to this project.\nVisible when the API user is a reports viewer on the project's account.."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"is_foreign_participant":{"type":"boolean","description":"Whether the participant is part of the project's account.\nOnly returned when requested through the optional_fields param."},"is_team_lead":{"type":"boolean","description":"Whether the participant is a team lead in the project."},"permissions_label":{"type":"string","description":"Whether the user has an edit permission, a view only permission, or a view permission with additional access. Possible values are `edit`, `view_only`, or `view_with_custom`.\nVisible when the API user is an administrator on the project.\n\nOnly returned when requested through the optional_fields param."},"primary_role_id":{"type":"string","description":"`primary_role_id` will only be included in the response if `primary_role` is in the list of included associations. See include section for usage."},"rate_in_cents":{"type":"integer","format":"int32","description":"The rate (in cents) for the participant for this project.\nVisible when the API user is a consultant on the project and has financial access on the project."},"role":{"type":"string","description":"The role for the participant."},"show_as_read_only":{"type":"boolean","description":"Whether the API user can only read the project."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."},"workspace_resource_ids":{"type":"array","items":{"type":"string"},"description":"`workspace_resource_ids` will only be included in the response if `workspace_resources` is in the list of included associations. See include section for usage."},"workspace_role_id":{"type":"string","description":"`workspace_role_id` will only be included in the response if `workspace_role` is in the list of included associations. See include section for usage."}}}},"components/schemas/Organization":{"id":"components/schemas/Organization","kind":"json-schema","title":"Organization","data":{"title":"Organization","description":"An Organization allows you to structure and group your projects and account members by\ndepartments and geographies.","type":"object","properties":{"ancestor_ids":{"type":"array","items":{"type":"string"},"description":"The ids of all ancestors of the organization."},"created_at":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The unique name of the organization."},"parent_id":{"type":"string","description":"The id of the parent organization."},"type":{"type":"string","description":"The type of the organization, either 'Geography' or 'Department'."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/OrganizationMembership":{"id":"components/schemas/OrganizationMembership","kind":"json-schema","title":"Organization Membership","data":{"title":"Organization Membership","description":"An Organization Membership represents the connection of a user and project to an organization.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"department_id":{"type":"string","description":"`department_id` will only be included in the response if `department` is in the list of included associations. See include section for usage."},"geography_id":{"type":"string","description":"`geography_id` will only be included in the response if `geography` is in the list of included associations. See include section for usage."},"member_id":{"type":"string","description":"The ID of the project or user."},"member_type":{"type":"string","description":"The type of object that describes the member (workspace or user)."},"primary":{"type":"boolean","description":"Indicates whether this is the primary organization for the member (user or workspace).\nVisible when the primary organization feature is enabled."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Participation":{"id":"components/schemas/Participation","kind":"json-schema","title":"Participation","data":{"title":"Participation","description":"Participations in Kantata OX connect Users and Workspaces (projects). It includes\npermissions, cost rate, bill rate and role details for the participant in the workspace.","type":"object","properties":{"access_level":{"type":"string","description":"Access level for the user in the workspace. It must be one of \"admin\", \"financial\", \"time_logging\", \"collaboration\".\nVisible when the API user is an administrator on the project.\n\nOnly returned when requested through the optional_fields param."},"active_role_ids":{"type":"array","items":{"type":"string"},"description":"`active_role_ids` will only be included in the response if `active_roles` is in the list of included associations. See include section for usage."},"allocated_workspace_minutes":{"type":"integer","format":"int32","description":"The allocated minutes for the participant scoped to this project.\nVisible when the API user is a reports viewer on the project's account.."},"can_edit":{"type":"boolean","description":"Whether the participant has edit permissions to the project.\nVisible when the API user is an administrator on the project."},"can_edit_expense":{"type":"boolean","description":"Whether the participant can edit expenses in the project.\nVisible when the API user is an administrator on the project."},"can_edit_time":{"type":"boolean","description":"Whether the participant can edit time in the project.\nVisible when the API user is an administrator on the project."},"can_invite":{"type":"boolean","description":"Whether the participant can invite others to the project."},"can_post":{"type":"boolean","description":"Whether the participant can post in the project.\nVisible when the API user is an administrator on the project."},"can_schedule_team_hours":{"type":"boolean","description":"Whether the participant can schedule hours for team members.\nOnly returned when requested through the optional_fields param."},"can_schedule_their_hours":{"type":"boolean","description":"Whether the participant can schedule their hours.\nOnly returned when requested through the optional_fields param."},"cost_in_cents":{"type":"integer","format":"int32","description":"The cost (in cents) for the participant for this this project.\nVisible when the API user is an administrator and a consultant on the project.."},"created_at":{"type":"string","format":"date-time"},"default_rate_in_cents":{"type":"integer","format":"int32","description":"The default rate (in cents) for the participant for this project.\nVisible when the API user is a consultant on the project and has financial access on the project."},"estimated_workspace_minutes":{"type":"integer","format":"int32","description":"The estimated minutes for the participant scoped to this project.\nVisible when the API user is a reports viewer on the project's account.."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"is_foreign_participant":{"type":"boolean","description":"Whether the participant is part of the project's account.\nOnly returned when requested through the optional_fields param."},"is_team_lead":{"type":"boolean","description":"Whether the participant is a team lead in the project."},"permissions_label":{"type":"string","description":"Whether the user has an edit permission, a view only permission, or a view permission with additional access. Possible values are `edit`, `view_only`, or `view_with_custom`.\nVisible when the API user is an administrator on the project.\n\nOnly returned when requested through the optional_fields param."},"primary_role_id":{"type":"string","description":"`primary_role_id` will only be included in the response if `primary_role` is in the list of included associations. See include section for usage."},"rate_in_cents":{"type":"integer","format":"int32","description":"The rate (in cents) for the participant for this project.\nVisible when the API user is a consultant on the project and has financial access on the project."},"role":{"type":"string","description":"The role for the participant."},"show_as_read_only":{"type":"boolean","description":"Whether the API user can only read the project."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."},"workspace_resource_ids":{"type":"array","items":{"type":"string"},"description":"`workspace_resource_ids` will only be included in the response if `workspace_resources` is in the list of included associations. See include section for usage."},"workspace_role_id":{"type":"string","description":"`workspace_role_id` will only be included in the response if `workspace_role` is in the list of included associations. See include section for usage."}}}},"components/schemas/Payment":{"id":"components/schemas/Payment","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object"}},"components/schemas/Post":{"id":"components/schemas/Post","kind":"json-schema","title":"Post","data":{"title":"Post","description":"A Post represents a message written by participants in a project that appears in the project.","type":"object","properties":{"attachment_ids":{"type":"array","items":{"type":"string"},"description":"`attachment_ids` will only be included in the response if `attachments` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time"},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"formatted_message":{"type":"string","description":"Sanitized HTML representation of the message with links, user mentions and emoji images."},"google_document_ids":{"type":"array","items":{"type":"string"},"description":"`google_document_ids` will only be included in the response if `google_documents` is in the list of included associations. See include section for usage."},"has_attachments":{"type":"boolean","description":"Whether the post contains any attachments."},"message":{"type":"string","description":"The message of the post."},"newest_reply_at":{"type":"string","format":"date-time","description":"The date and time of the most recent reply."},"newest_reply_id":{"type":"string","description":"`newest_reply_id` will only be included in the response if `newest_reply` is in the list of included associations. See include section for usage."},"newest_reply_user_id":{"type":"string","description":"`newest_reply_user_id` will only be included in the response if `newest_reply_user` is in the list of included associations. See include section for usage."},"parsed_message":{"type":"string","description":"Based on the markdown preference, includes either the parsed markdown or the message."},"private":{"type":"boolean","description":"Whether the post is private."},"recipient_ids":{"type":"array","items":{"type":"string"},"description":"`recipient_ids` will only be included in the response if `recipients` is in the list of included associations. See include section for usage."},"reply":{"type":"boolean","description":"Whether there are any replies to the post."},"reply_count":{"type":"integer","format":"int32","description":"The number of replies to the post."},"reply_ids":{"type":"array","items":{"type":"string"},"description":"`reply_ids` will only be included in the response if `replies` is in the list of included associations. See include section for usage."},"story_id":{"type":"string","description":"`story_id` will only be included in the response if `story` is in the list of included associations. See include section for usage."},"subject_id":{"type":"integer","format":"int32","description":"Whether the post is a reply, the internal ID of the parent post, or the object to which the reply is made."},"subject_ref":{"type":"object","description":"`subject_ref` will only be included in the response if `subject` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"subject_title":{"type":"string","description":"The subject title for proof posts."},"subject_type":{"type":"string","description":"The class name of the object to which the reply is made."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/PrivateLabel":{"id":"components/schemas/PrivateLabel","kind":"json-schema","title":"Custom Branding (Private Label)","data":{"title":"Custom Branding (Private Label)","description":"The Custom Branding values for the current users account.","type":"object","properties":{"business_name":{"type":"string","description":"Business name alias."},"button_color":{"type":"string","description":"Hex value of chosen button color."},"created_at":{"type":"string","format":"date-time","description":"The date the custom branding was created."},"custom_login_message":{"type":"string","description":"Value of the custom login message if set."},"header_color":{"type":"string","description":"Hex value of chosen header color."},"left_nav_background_color":{"type":"string","description":"Hex value of the chosen left navigation color."},"left_nav_button_color":{"type":"string","description":"Hex value of the left nav button."},"link_color":{"type":"string","description":"Hex value of chosen link color."},"logo_url":{"type":"string","description":"URL of the chosen logo."},"state":{"type":"string","description":"The current state of custom branding on the account with possible values: new and disabled, disabled, active, preview."},"updated_at":{"type":"string","format":"date-time","description":"The date the custom branding was most recently updated."}}}},"components/schemas/ProjectTemplate":{"id":"components/schemas/ProjectTemplate","kind":"json-schema","title":"Project Template","data":{"title":"Project Template","description":"Project Templates are sets of tasks and attributes that can be applied to new or existing projects.\n A single template can be used on any number of projects.","type":"object","properties":{"budget":{"type":"integer","format":"int32","description":"The estimated overall budget of the project associated with the template."},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string","description":"The currency of the project template."},"description":{"type":"string","description":"A description of the project template (this does not map over to the project description when applied)."},"duration":{"type":"integer","format":"int32","description":"The estimated number of days that the project will take to complete."},"is_budgeted":{"type":"boolean","description":"The project template has financial attributes including overall budget, task budgets, and task time estimates."},"item_count":{"type":"integer","format":"int32","description":"The number of tasks in the project template."},"permissions":{"type":"object","properties":{"can_edit_project_template":{"type":"boolean","description":"Whether the current user can edit the project template."}}},"project_template_additional_tab_ids":{"type":"array","items":{"type":"string"},"description":"`project_template_additional_tab_ids` will only be included in the response if `project_template_additional_tabs` is in the list of included associations. See include section for usage."},"project_template_assignment_ids":{"type":"array","items":{"type":"string"},"description":"`project_template_assignment_ids` will only be included in the response if `project_template_assignments` is in the list of included associations. See include section for usage."},"raw_json":{"type":"string","description":"A json hash that contains all the project templates tasks.\nOnly returned when requested through the optional_fields param."},"shared":{"type":"boolean","description":"(Deprecated in favor of sharing) The project template is shared with users on the account, other than the creator."},"sharing":{"type":"string","description":"The project template sharing settings. A template can be private, shared, or editable."},"title":{"type":"string","description":"The title of the project template."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."}}}},"components/schemas/ProjectTemplateAdditionalTab":{"id":"components/schemas/ProjectTemplateAdditionalTab","kind":"json-schema","title":"Project Template Additional Tab","data":{"title":"Project Template Additional Tab","description":"Project Template Additional Tabs are additional tabs configured in a project template that are added to a project when the template is applied.","type":"object","properties":{"associated_tab_id":{"type":"integer","format":"int32","description":"The ID of the form or Insights dynamic dashboard that is a project template additional tab."},"project_template_id":{"type":"integer","format":"int32","description":"The ID of the template the additional tab is associated with."},"tab_type":{"type":"string","description":"The type of additional project tab. Possible values are `form` and `dashboard` (i.e. an Insights dynamic dashboard)."}}}},"components/schemas/ProjectTemplateAssignment":{"id":"components/schemas/ProjectTemplateAssignment","kind":"json-schema","title":"Project Template Assignment","data":{"title":"Project Template Assignment","description":"Project Template Assignments represent placeholders for task assignees in project templates.","type":"object","properties":{"name":{"type":"string","description":"The name of resource or assignment placeholder for the associated project template."},"project_template_id":{"type":"string","description":"`project_template_id` will only be included in the response if `project_template` is in the list of included associations. See include section for usage."},"role_id":{"type":"string","description":"`role_id` will only be included in the response if `role` is in the list of included associations. See include section for usage."},"role_initials":{"type":"string","description":"Three letter initals for the Resource's Role if any.\nOnly returned when requested through the optional_fields param."},"role_name":{"type":"string","description":"Name of the Resource's role if any.\nOnly returned when requested through the optional_fields param."},"total_count":{"type":"integer","format":"int32","description":"\nOnly returned when requested through the optional_fields param."},"total_estimated_minutes":{"type":"integer","format":"int32","description":"\nOnly returned when requested through the optional_fields param."}}}},"components/schemas/ProjectTemplateExpenseBudget":{"id":"components/schemas/ProjectTemplateExpenseBudget","kind":"json-schema","title":"Project Template Expense Budget","data":{"title":"Project Template Expense Budget","description":"Project Template Expense Budgets are expense budgets configured in a project\ntemplate that are added to a project when the template is applied.","type":"object","properties":{"billable":{"type":"boolean","description":"Whether the expense will be billed to the client."},"burns_budget":{"type":"boolean","description":"Whether the expense budget affects the project margin."},"cost_per_unit_in_subunits":{"type":"integer","format":"int32","description":"The cost per unit, in the subunits of the currency (e.g. cents for USD)."},"created_at":{"type":"string","format":"date-time","description":"When the expense budget on the template was created."},"description":{"type":"string","description":"The description of the expense budget."},"fixed_fee":{"type":"boolean","description":"Whether the expense will be billed as a fixed cost."},"markup_per_unit_in_subunits":{"type":"integer","format":"int32","description":"The markup per unit, in the subunits of the currency (e.g. cents for USD)."},"markup_percentage":{"type":"integer","format":"int32","description":"If the `markup_type` is `percentage`, this is the percentage markup for the expense budget."},"markup_type":{"type":"string","description":"The type of markup for the expense budget. Possible values are `flat_fee` and `percentage`."},"project_template_id":{"type":"integer","format":"int32","description":"The ID of the project template the expense budget is on."},"quantity":{"type":"integer","format":"int32","description":"The number of expected units for the expense budget."},"relative_expected_by_date":{"type":"integer","format":"int32","description":"When the expenses are expected to be logged, relative to the project’s start date."},"title":{"type":"string","description":"The title of the expense budget."},"updated_at":{"type":"string","format":"date-time","description":"When the expense budget on the template was last updated."}}}},"components/schemas/Proof":{"id":"components/schemas/Proof","kind":"json-schema","title":"Proof","data":{"title":"Proof","description":"Proofs are assets, belonging to a task that has been uploaded for review. Although they can have\nseveral revisions, proofs only have a single *current* revision.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"creator_name":{"type":"string","description":"The full name of the user who uploaded the current revision."},"current_revision_id":{"type":"string","description":"`current_revision_id` will only be included in the response if `current_revision` is in the list of included associations. See include section for usage."},"download_url":{"type":"string","description":"The URL from which to download the attachment associated with the current revision of the proof."},"filename":{"type":"string","description":"The name of the file associated with the current revision."},"filesize":{"type":"integer","format":"int32","description":"The file size of the attachment associated with the current revision."},"has_comments":{"type":"boolean","description":"Whether there are comments on the current revision in the proofing workspace."},"review_status":{"type":"string","description":"The status of the active proof review (if one exists)."},"review_url":{"type":"string","description":"The URL from which to view the proof in the proofing workspace."},"revision_count":{"type":"integer","format":"int32","description":"The number of revisions."},"revision_date":{"type":"string","format":"date-time","description":"The date that the current revision was created."},"revision_ids":{"type":"array","items":{"type":"string"},"description":"`revision_ids` will only be included in the response if `revisions` is in the list of included associations. See include section for usage."},"story_id":{"type":"string","description":"`story_id` will only be included in the response if `story` is in the list of included associations. See include section for usage."},"title":{"type":"string"},"viewable":{"type":"boolean","description":"Whether the proof has finished processing and is ready to be viewed in the proofing workspace."}}}},"components/schemas/ProofReview":{"id":"components/schemas/ProofReview","kind":"json-schema","title":"Proof Review","data":{"title":"Proof Review","description":"Represents the review of a proof and its current status.","type":"object","properties":{"can_modify":{"type":"boolean","description":"Whether the current user can modify the proof review."},"participation_ids":{"type":"array","items":{"type":"string"},"description":"`participation_ids` will only be included in the response if `participations` is in the list of included associations. See include section for usage."},"proof_revision_id":{"type":"string","description":"`proof_revision_id` will only be included in the response if `proof_revision` is in the list of included associations. See include section for usage."},"status":{"type":"string","description":"The current status of the proof review. This can be *In Progress*, *Approved*, or *Rejected*."}}}},"components/schemas/ProofReviewParticipation":{"id":"components/schemas/ProofReviewParticipation","kind":"json-schema","title":"Proof Review Participation","data":{"title":"Proof Review Participation","description":"Represent a users's involvement (participation) in the review of a proof.","type":"object","properties":{"project_review_id":{"type":"string","description":"`project_review_id` will only be included in the response if `proof_review` is in the list of included associations. See include section for usage."},"status":{"type":"string","description":"The status of the participation. This can be 'waiting', 'rejected', or 'approved'."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user associated with the participation."}}}},"components/schemas/ProofRevision":{"id":"components/schemas/ProofRevision","kind":"json-schema","title":"Proof Revision","data":{"title":"Proof Revision","description":"A Proof Revision represents a specific version of a proof. The latest version that\nmost operations are taken on is the \"current\" revision.","type":"object","properties":{"creator_name":{"type":"string","description":"The full name of the user who created the revision."},"current":{"type":"boolean","description":"True if the revision is the current revision. This is the only revision of the proof that can be reviewed."},"download_url":{"type":"string","description":"The URL from which to download the attachment associated with the revision."},"filesize":{"type":"integer","format":"int32","description":"The filesize of the attachment associated with the revision."},"original_filename":{"type":"string","description":"The filename of the attachment when the revision was created."},"proof_id":{"type":"string","description":"`proof_id` will only be included in the response if `proof` is in the list of included associations. See include section for usage."},"proof_review_id":{"type":"string","description":"`proof_review_id` will only be included in the response if `proof_review` is in the list of included associations. See include section for usage."},"review_url":{"type":"string","description":"The URL with which to view the revision in the proofing workspace."},"revision_date":{"type":"string","format":"date-time","description":"The date the revision was created."}}}},"components/schemas/RateCard":{"id":"components/schemas/RateCard","kind":"json-schema","title":"Rate Card","data":{"title":"Rate Card","description":"A Rate Card belongs to a Rate Card Set, and represents a currency in the set. Rate Cards have\nmany Rate Card Versions which represent the effective version of a Rate Card at a specified point of time.\n\nRate Cards are accessible to users with Financial access (Project Lead or higher) on the account.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string","description":"The currency of the Rate Card."},"effective_rate_card_version_id":{"type":"string","description":"`effective_rate_card_version_id` will only be included in the response if `effective_rate_card_version` is in the list of included associations. See include section for usage."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"rate_card_set_id":{"type":"string","description":"`rate_card_set_id` will only be included in the response if `rate_card_set` is in the list of included associations. See include section for usage."},"rate_card_set_title":{"type":"string","description":"The Rate Card Set and Currency."},"rate_card_version_ids":{"type":"array","items":{"type":"string"},"description":"`rate_card_version_ids` will only be included in the response if `rate_card_versions` is in the list of included associations. See include section for usage."},"removable":{"type":"boolean","description":"Whether or not the Rate Card can be deleted."},"updated_at":{"type":"string","format":"date-time"},"uses":{"type":"integer","format":"int32","description":"The total usage count of the Rate Card."}}}},"components/schemas/RateCardRole":{"id":"components/schemas/RateCardRole","kind":"json-schema","title":"Rate Card Role","data":{"title":"Rate Card Role","description":"A Rate Card Role belongs to a Rate Card Version and represents the bill rate, in cents per hour, for a Role\nFor example, the rate for a developer may be 2000 cents per hour.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"rate":{"type":"integer","format":"int32","description":"The bill rate, in cents per hour, for the Rate Card Role."},"rate_card_version_id":{"type":"string","description":"`rate_card_version_id` will only be included in the response if `rate_card_version` is in the list of included associations. See include section for usage."},"role_id":{"type":"string","description":"`role_id` will only be included in the response if `role` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/RateCardSet":{"id":"components/schemas/RateCardSet","kind":"json-schema","title":"Rate Card Set","data":{"title":"Rate Card Set","description":"A Rate Card Set represents a group of Rate Cards with multiple currencies, that\ncan be bundled together. A Rate Card Set belongs to an account, and can have several Rate Card Set Versions, each representing the\nthe effective version for a specified date.","type":"object","properties":{"account_default":{"type":"boolean","description":"Whether the Rate Card Set is an account default."},"active_currencies":{"type":"array","items":{"type":"string"},"description":"Includes only currencies that belong to published Rate Card Set Versions."},"created_at":{"type":"string","format":"date-time"},"default_currencies":{"type":"array","items":{"type":"string"},"description":"Includes only currencies that belong to published Rate Card Set Versions on the account default Rate Card Set."},"destroyable":{"type":"boolean","description":"Whether the Rate Card Set can be deleted."},"rate_card_ids":{"type":"array","items":{"type":"string"},"description":"`rate_card_ids` will only be included in the response if `rate_cards` is in the list of included associations. See include section for usage."},"rate_card_set_version_ids":{"type":"array","items":{"type":"string"},"description":"`rate_card_set_version_ids` will only be included in the response if `rate_card_set_versions` is in the list of included associations. See include section for usage."},"title":{"type":"string","description":"The title of the Rate Card Set."},"updated_at":{"type":"string","format":"date-time"},"workspace_group_ids":{"type":"array","items":{"type":"string"},"description":"`workspace_group_ids` will only be included in the response if `workspace_groups` is in the list of included associations. See include section for usage."}}}},"components/schemas/RateCardSetVersion":{"id":"components/schemas/RateCardSetVersion","kind":"json-schema","title":"Rate Card Set Version","data":{"title":"Rate Card Set Version","description":"Rate Card Set Versions represent a snapshot of a Rate Card Set\n which takes effect on the set published date. A Rate Card Set Version owns a copy of each Rate Card Version\n of a Rate Card on the associated Rate Card Set.\nRate Card Set Versions are only accessible, editable and publishable by Administrators on the account.","type":"object","properties":{"active":{"type":"boolean","description":"Whether the Rate Card Set Version is published."},"created_at":{"type":"string","format":"date-time"},"effective_date":{"type":"string","format":"date","description":"The date on which the Rate Card Set Version take effect."},"rate_card_set_id":{"type":"string","description":"`rate_card_set_id` will only be included in the response if `rate_card_set` is in the list of included associations. See include section for usage."},"rate_card_version_ids":{"type":"array","items":{"type":"string"},"description":"`rate_card_version_ids` will only be included in the response if `rate_card_versions` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time"},"used_currencies":{"type":"array","items":{"type":"string"},"description":"Available currencies on Rate Cards associated with this Rate Card Set Version."}}}},"components/schemas/RateCardVersion":{"id":"components/schemas/RateCardVersion","kind":"json-schema","title":"Rate Card Version","data":{"title":"Rate Card Version","description":"A Rate Card Version represents a snapshot of a Rate Card at a specified point in time and is used to set the\ndefault rate. It belongs to a Rate Card Set Version and can own many Rate Card Roles.\n\nThe default Rate is the Rate applied for any Roles that do not explicitly have a Rate set.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"default_rate":{"type":"integer","format":"int32","description":"The default Rate for any Role that does not explicitly have a Rate associated with it."},"rate_card_id":{"type":"string","description":"`rate_card_id` will only be included in the response if `rate_card` is in the list of included associations. See include section for usage."},"rate_card_role_ids":{"type":"array","items":{"type":"string"},"description":"`rate_card_role_ids` will only be included in the response if `rate_card_roles` is in the list of included associations. See include section for usage."},"rate_card_set_version_id":{"type":"string","description":"`rate_card_set_version_id` will only be included in the response if `rate_card_set_version` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Resolution":{"id":"components/schemas/Resolution","kind":"json-schema","title":"Resolution","data":{"title":"Resolution","description":"A resolution is a submission approval, rejection, or cancelation. This can be for an expense report \nsubmission or a timesheet submission.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"description":{"type":"string","description":"Additional resolution details."},"target_id":{"type":"integer","format":"int32","description":"The id of the associated submission."},"target_type":{"type":"string","description":"Whether the resolution is for a timesheet submission or an expense report submission."},"type":{"type":"string","description":"The resolution type, either approval, rejection, or cancellation."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"integer","format":"int32","description":"The id of the user who created the resolution."}}}},"components/schemas/Resource":{"id":"components/schemas/Resource","kind":"json-schema","title":"Resource","data":{"title":"Resource","type":"object","properties":{"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"label":{"type":"string"},"organization_membership_id":{"type":"string","description":"`organization_membership_id` will only be included in the response if `organization_membership` is in the list of included associations. See include section for usage."},"role_id":{"type":"string","description":"`role_id` will only be included in the response if `role` is in the list of included associations. See include section for usage."},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."}}}},"components/schemas/ResourceRequest":{"id":"components/schemas/ResourceRequest","kind":"json-schema","title":"Resource Requests","data":{"title":"Resource Requests","description":"Resource Requests are used as a method for a requestor to ask an approver to staff a resource.\nResource Requests are associated to a workspace resource and must have an approver associated.","type":"object","properties":{"approver_ids":{"type":"array","items":{"type":"string"},"description":"`approver_ids` will only be included in the response if `approvers` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time"},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"resource_id":{"type":"string","description":"`resource_id` will only be included in the response if `resource` is in the list of included associations. See include section for usage."},"status":{"type":"string","description":"The current state of the request: new, cancelled, rejected, or approved."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Role":{"id":"components/schemas/Role","kind":"json-schema","title":"Role","data":{"title":"Role","description":"A Role represents the main position or title assigned to members on an account. Roles may be associated with account memberships, account invitations,\nparticipation, project template assignments, rate card roles, rate card versions, resources, or time adjustments.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"deleted_at":{"type":"string","format":"date-time","description":"The time the role was deleted."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"name":{"type":"string","description":"The name of the role."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Skill":{"id":"components/schemas/Skill","kind":"json-schema","title":"Skill","data":{"title":"Skill","description":"Skills are used in Kantata OX to describe capabilities of users for the purposes of resource planning.\nThey can be associated with a user through a Skill Membership.\nThis model includes categories such as 'Skill', 'Language', 'Certification' and 'Other'.","type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time a skill was last updated."},"description":{"type":"string","description":"The description of the skill."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"max_level":{"type":"string","description":"The max level allowed for the skill."},"name":{"type":"string","description":"The name of the skill."},"skill_category_id":{"type":"string","description":"`skill_category_id` will only be included in the response if `skill_category` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time","description":"The date and time at skill a workweek was created."}}}},"components/schemas/SkillCategory":{"id":"components/schemas/SkillCategory","kind":"json-schema","title":"Skill Category","data":{"title":"Skill Category","description":"The classification for a group of skills.","type":"object","properties":{"name":{"type":"string","description":"The name of the skill category."},"skill_ids":{"type":"array","items":{"type":"string"},"description":"`skill_ids` will only be included in the response if `skills` is in the list of included associations. See include section for usage."}}}},"components/schemas/SkillMembership":{"id":"components/schemas/SkillMembership","kind":"json-schema","title":"Skill Membership","data":{"title":"Skill Membership","description":"A Skill Membership represents a skill that has been assigned to a specified user.","type":"object","properties":{"cached_skill_name":{"type":"string","description":"The name of the skill."},"created_at":{"type":"string","format":"date-time"},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"level":{"type":"integer","format":"int32","description":"The objects proficiency level for the skill (1-5)."},"max_level":{"type":"integer","format":"int32","description":"The maximum level assigned for the skill."},"skill_id":{"type":"string","description":"`skill_id` will only be included in the response if `skill` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."}}}},"components/schemas/StatusReport":{"id":"components/schemas/StatusReport","kind":"json-schema","title":"Status Report","data":{"title":"Status Report","description":"A Status Report provides a color level and description for a projects status. Referred to as Health Report in the UI.","type":"object","properties":{"color":{"type":"string","description":"The status color for for the report overall. One of green, yellow, red."},"created_at":{"type":"string","format":"date-time","description":"The date the status report was created."},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"description":{"type":"string","description":"The description of the overall status of the project."},"details":{"type":"array","description":"Optional color and description for various categories of a project's health.","items":{"type":"object","properties":{"category":{"type":"string","description":"The category for which this detail applies. One of Scope, Budget, Schedule, Client."},"color":{"type":"string","description":"The status color for the specified category. One of green, yellow, red."},"description":{"type":"string","description":"A description of the status of the specified category."}}}},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time","description":"The date the status report was last updated."},"updater_id":{"type":"string","description":"`updater_id` will only be included in the response if `updater` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/StatusSet":{"id":"components/schemas/StatusSet","kind":"json-schema","title":"Task Status Set","data":{"title":"Task Status Set","description":"Task Status Sets allow you to create custom statuses for tasks (stories) that can then be applied to projects (workspaces).","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"custom_task_status_ids":{"type":"array","items":{"type":"string"},"description":"`custom_task_status_ids` will only be included in the response if `custom_task_statuses` is in the list of included associations. See include section for usage."},"name":{"type":"string","description":"The name of this status set."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/StatusSetOption":{"id":"components/schemas/StatusSetOption","kind":"json-schema","title":"Custom Task Status","data":{"title":"Custom Task Status","description":"A custom task status is in a Task Status Set. A task status set is assigned to a workspace (project), then custom task statuses can be applied to the stories (tasks) within the workspace.","type":"object","properties":{"category":{"type":"string","description":"The type of the status. Possible values are `not started`, `started`, `needs info`, or `completed`."},"created_at":{"type":"string","format":"date-time"},"position":{"type":"integer","format":"int32","description":"The position of this status within the task status set."},"status":{"type":"string","description":"The name of the custom task status."},"status_set_id":{"type":"integer","format":"int32","description":"The ID of the task status set that this status is within."},"task_status_set_id":{"type":"string","description":"`task_status_set_id` will only be included in the response if `task_status_set` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Story":{"id":"components/schemas/Story","kind":"json-schema","title":"Story","data":{"title":"Story","description":"Stories (known as [tasks](https://knowledge.kantata.com/hc/en-us/articles/202806550-Tasks-Overview) in the UI)\nare the tasks, deliverables, issues, and milestones required to complete a project.\nStories belong to [Workspaces](/tag/Workspaces), appear in the\n[Local Task Tracker](https://knowledge.kantata.com/hc/en-us/articles/202490134-Project-Task-Tracker) and the\n[Global Tasks Tracker](https://knowledge.kantata.com/hc/en-us/articles/216424897-Global-Tasks-Tracker),\ncan be linked to [Posts](/tag/Posts), can have substories (subtasks) and\n[Story Tasks](https://developer.kantata.com/tag/Story-Tasks) (checklists), and have many attributes for\nplanning, organization, and financials.","type":"object","properties":{"ancestor_ids":{"type":"array","items":{"type":"string"},"description":"The IDs of all the ancestor (i.e. parent) tasks of the task. This is empty for a top-level task."},"ancestry_depth":{"type":"integer","format":"int32","description":"The number of levels a subtask is nested below the top-level task. Possible values are between `0` (i.e. a top-level task) and `4`."},"archived":{"type":"boolean","description":"Whether the task is archived."},"archived_editable":{"type":"boolean","description":"For archived tasks, whether the authenticated user can edit the task.\nOnly returned when requested through the optional_fields param."},"assigned_role_id":{"type":"string","description":"`assigned_role_id` will only be included in the response if `assigned_role` is in the list of included associations. See include section for usage."},"assignee_ids":{"type":"array","items":{"type":"string"},"description":"`assignee_ids` will only be included in the response if `assignees` is in the list of included associations. See include section for usage."},"assignment_timestamped_at":{"type":"string","format":"date-time"},"attachment_ids":{"type":"array","items":{"type":"string"},"description":"`attachment_ids` will only be included in the response if `attachments` is in the list of included associations. See include section for usage."},"billable":{"type":"boolean","description":"Whether the task is billable."},"budget_estimate_in_cents":{"type":"integer","format":"int32","description":"The task budget, in the subunits of the currency (e.g. cents for USD).\nVisible when the API user can view story budgets in the story's workspace."},"budget_used_in_cents":{"type":"integer","format":"int32","description":"How much of the task budget has been used, in the subunits of the currency (e.g. cents for USD).\nVisible when the API user can view story budgets in the story's workspace."},"can_align_time":{"type":"boolean","description":"Whether [Daily Scheduled Hours](/tag/Daily-Scheduled-Hours-(Story-Allocation-Days)) (i.e. Story Allocation Days) that are out of sync with the task start or due date can be realigned to the task start date.\nOnly returned when requested through the optional_fields param."},"can_edit":{"type":"boolean","description":"Whether the authenticated user can edit the task. For archived tasks, refer to `archived_editable` instead.\nOnly returned when requested through the optional_fields param."},"can_post":{"type":"boolean","description":"Whether the authenticated user can create posts in the project the task is in.\nOnly returned when requested through the optional_fields param."},"created_at":{"type":"string","format":"date-time"},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"current_assignment_ids":{"type":"array","items":{"type":"string"},"description":"`current_assignment_ids` will only be included in the response if `current_assignments` is in the list of included associations. See include section for usage."},"custom_field_value_ids":{"type":"array","items":{"type":"string"},"description":"`custom_field_value_ids` will only be included in the response if `custom_field_values` is in the list of included associations. See include section for usage."},"custom_task_status_id":{"type":"integer","format":"int32","description":"The ID of the task's custom status. If the workspace is not using a custom task status set, this is `null`.\nOnly returned when requested through the optional_fields param."},"deleted_at":{"type":"string","format":"date-time"},"descendant_ids":{"type":"array","items":{"type":"string"},"description":"`descendant_ids` will only be included in the response if `descendants` is in the list of included associations. See include section for usage."},"description":{"type":"string","description":"The task description. Markdown syntax is included."},"due_date":{"type":"string","format":"date","description":"When the task is due."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"fixed_fee":{"type":"boolean","description":"Whether the task is fixed fee (`true`) or time and materials (`false`)."},"follower_ids":{"type":"array","items":{"type":"string"},"description":"`follower_ids` will only be included in the response if `followers` is in the list of included associations. See include section for usage."},"formatted_description":{"type":"string","description":"The task description with special formatting, like emoji and @-mentions.\nOnly returned when requested through the optional_fields param."},"google_document_ids":{"type":"array","items":{"type":"string"},"description":"`google_document_ids` will only be included in the response if `google_documents` is in the list of included associations. See include section for usage."},"has_out_of_bounds_sads":{"type":"boolean","description":"Whether the task has any [Daily Scheduled Hours](/tag/Daily-Scheduled-Hours-(Story-Allocation-Days)) (i.e. Story Allocation Days) before its start date or after its due date.\nOnly returned when requested through the optional_fields param."},"invoiced_balance_in_cents":{"type":"integer","format":"int32","description":"How much has been invoiced for the task, in the subunits of the currency (e.g. cents for USD).\nVisible when the API user can view story budgets in the story's workspace."},"is_time_trackable_type":{"type":"boolean","description":"Whether the task can have time and expenses tracked against it, as set in account settings.\nOnly returned when requested through the optional_fields param."},"logged_billable_time_in_minutes":{"type":"integer","format":"int32","description":"How much billable time has been tracked against the task, in minutes.\nVisible when the API user can view story time estimates in the story's workspace."},"logged_nonbillable_time_in_minutes":{"type":"integer","format":"int32","description":"How much non-billable time has been tracked against the task, in minutes.\nVisible when the API user can view story time estimates in the story's workspace."},"parent_id":{"type":"string","description":"`parent_id` will only be included in the response if `parent` is in the list of included associations. See include section for usage."},"parsed_description":{"type":"string","description":"The task description. Markdown syntax is not included.\nOnly returned when requested through the optional_fields param."},"percentage_complete":{"type":"integer","format":"int32","description":"The percentage of work done on the task."},"position":{"type":"integer","format":"int32","description":"Represents the task's position in the Task Tracker. This is not the same as the WBS (Work Breakdown Structure) number shown in the UI."},"potential_workspace_resource_ids":{"type":"array","items":{"type":"string"},"description":"`potential_workspace_resource_ids` will only be included in the response if `potential_workspace_resources` is in the list of included associations. See include section for usage."},"potential_workspace_resources_with_unnamed_ids":{"type":"array","items":{"type":"string"},"description":"`potential_workspace_resources_with_unnamed_ids` will only be included in the response if `potential_workspace_resources_with_unnamed` is in the list of included associations. See include section for usage."},"priority":{"type":"integer","format":"int32","description":"The priority of the task. Possible values are `critical`, `high`, `normal`, `low`."},"project_plan":{"type":"boolean","description":"Whether the story is a project task (`true`) or is a To Do (`false`)."},"read_only":{"type":"boolean","description":"Whether the authenticated user can only view the task and cannot edit it.\nOnly returned when requested through the optional_fields param."},"render_description_markdown":{"type":"boolean","description":"Whether the account the task is in is set to render Markdown in task descriptions as formatted and styled text.\nOnly returned when requested through the optional_fields param."},"reply_ids":{"type":"array","items":{"type":"string"},"description":"`reply_ids` will only be included in the response if `replies` is in the list of included associations. See include section for usage."},"root_id":{"type":"string","description":"`root_id` will only be included in the response if `root` is in the list of included associations. See include section for usage."},"source_dependency_ids":{"type":"array","items":{"type":"string"},"description":"`source_dependency_ids` will only be included in the response if `source_dependencies` is in the list of included associations. See include section for usage."},"start_date":{"type":"string","format":"date","description":"When the task starts."},"state":{"type":"string","description":"The status type of the story. Possible values are `not started`, `started`, `needs info`, or `completed`. If task status sets are not activated on the account, the following values are also possible: `new`, `reopened`, `in progress`, `blocked`, `fixed`, `duplicate`, `can't reproduce`, `resolved`, or `won't fix`. The actual task status is returned in the `status` field."},"status":{"type":"string","description":"The status of the story."},"story_state_change_ids":{"type":"array","items":{"type":"string"},"description":"`story_state_change_ids` will only be included in the response if `story_state_changes` is in the list of included associations. See include section for usage."},"story_task_ids":{"type":"array","items":{"type":"string"},"description":"`story_task_ids` will only be included in the response if `story_tasks` is in the list of included associations. See include section for usage."},"story_type":{"type":"string","description":"The task's type. Possible values are `task`, `deliverable `, `milestone`, and `issue`."},"sub_stories_billable_time_in_minutes":{"type":"integer","format":"int32","description":"How much billable time has been tracked against the task's descendants, in minutes.\nVisible when the API user can view story time estimates in the story's workspace."},"sub_stories_budget_estimate_in_cents":{"type":"integer","format":"int32","description":"The budget of the task's descendants, in the subunits of the currency (e.g. cents for USD).\nVisible when the API user can view story budgets in the story's workspace."},"sub_stories_budget_used_in_cents":{"type":"integer","format":"int32","description":"How much of the budgets of the task's descendants has been used, in the subunits of the currency (e.g. cents for USD).\nVisible when the API user can view story budgets in the story's workspace."},"sub_stories_time_estimate_in_minutes":{"type":"integer","format":"int32","description":"The estimated time of the task's descendants, in minutes.\nVisible when the API user can view story time estimates in the story's workspace."},"sub_story_count":{"type":"integer","format":"int32","description":"How many descendant tasks the task has."},"sub_story_ids":{"type":"array","items":{"type":"string"},"description":"`sub_story_ids` will only be included in the response if `sub_stories` is in the list of included associations. See include section for usage."},"subtree_depth":{"type":"integer","format":"int32","description":"How many ancestor tasks the task has."},"tag_ids":{"type":"array","items":{"type":"string"},"description":"`tag_ids` will only be included in the response if `tags` is in the list of included associations. See include section for usage."},"target_dependency_ids":{"type":"array","items":{"type":"string"},"description":"`target_dependency_ids` will only be included in the response if `target_dependencies` is in the list of included associations. See include section for usage."},"time_estimate_in_minutes":{"type":"integer","format":"int32","description":"The estimated time for the task, in minutes.\nVisible when the API user can view story time estimates in the story's workspace."},"time_trackable":{"type":"boolean","description":"Whether time can be tracked against the task."},"title":{"type":"string","description":"The title of the task."},"uninvoiced_balance_in_cents":{"type":"integer","format":"int32","description":"How much has not yet been invoiced for the task, in the subunits of the currency (e.g. cents for USD).\nVisible when the API user can view story budgets in the story's workspace."},"updated_at":{"type":"string","format":"date-time"},"weight":{"type":"integer","format":"int32","description":"If the `story_type` is `milestone`, this is the [weight](https://knowledge.kantata.com/hc/en-us/articles/203499904-Milestone-Weighting) of the task.\nVisible when the API user can view story time estimates in the story's workspace."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."},"workspace_resource_ids":{"type":"array","items":{"type":"string"},"description":"`workspace_resource_ids` will only be included in the response if `workspace_resources` is in the list of included associations. See include section for usage."},"workspace_resources_with_unnamed_ids":{"type":"array","items":{"type":"string"},"description":"`workspace_resources_with_unnamed_ids` will only be included in the response if `workspace_resources_with_unnamed` is in the list of included associations. See include section for usage."}}}},"components/schemas/StoryAllocationDay":{"id":"components/schemas/StoryAllocationDay","kind":"json-schema","title":"Daily Scheduled Hours (Story Allocation Day)","data":{"title":"Daily Scheduled Hours (Story Allocation Day)","description":"Daily Scheduled Hours (Story Allocation Day) is the planned amount of time for a project resource\non a specific task for a specified day. Daily Scheduled Hours in Kantata OX are owned by an Assignment.","type":"object","properties":{"assignment_id":{"type":"string","description":"`assignment_id` will only be included in the response if `assignment` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time"},"current":{"type":"boolean","description":"Whether or not the Story Allocation Day's Assignment is active."},"date":{"type":"string","format":"date","description":"The date of the Story Allocation Day."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"minutes":{"type":"integer","format":"int32","description":"The number of minutes allocated for the Story Allocation Day."},"story_id":{"type":"string","description":"`story_id` will only be included in the response if `story` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time"},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/StoryDependency":{"id":"components/schemas/StoryDependency","kind":"json-schema","title":"Story Dependency","data":{"title":"Story Dependency","description":"Story dependencies define relationships between tasks and the sequence in which they must be completed in order to close a project. A dependency is between two tasks (stories) in a project (workspace), with one being the predecessor (source) task, and the other the successor (target) task. To learn more about dependencies, see our [Gantt Chart Dependencies article](https://mavenlink.zendesk.com/hc/en-us/articles/360000456874-Gantt-Chart-Dependencies).","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"dependency_type":{"type":"integer","format":"int32","description":"The type of the dependency.\n- `0`: Start to Start (SS)—The predecessor begins before the successor can begin.\n- `1`: Start to Finish (SF)—The predecessor begins before the successor can end.\n- `2`: Finish to Start (FS)—The predecessor ends before the successor can begin.\n- `3`: Finish to Finish (FF)—The predecessor ends before the successor can end."},"lag":{"type":"integer","format":"int32","description":"The days between the predecessor task ending and the successor task beginning."},"source_id":{"type":"string","description":"`source_id` will only be included in the response if `source` is in the list of included associations. See include section for usage."},"target_id":{"type":"string","description":"`target_id` will only be included in the response if `target` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/StoryFollow":{"id":"components/schemas/StoryFollow","kind":"json-schema","title":"Story Follow (Follower)","data":{"title":"Story Follow (Follower)","description":"Story Follow allows a user to follow a task to which they are not assigned.","type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time that the story follow was created."},"follower_id":{"type":"string","description":"`follower_id` will only be included in the response if `follower` is in the list of included associations. See include section for usage."},"story_id":{"type":"string","description":"`story_id` will only be included in the response if `story` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time","description":"The date and time that the story follow was last updated."}}}},"components/schemas/StoryStateChange":{"id":"components/schemas/StoryStateChange","kind":"json-schema","title":"Story State Change","data":{"title":"Story State Change","description":"A Story State Changes in Kantata OX acts as an audit trail for a change to the state of a Story.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"formatted_state":{"type":"string","description":"The formatted version of the new state of the story."},"state":{"type":"string","description":"The new state of the story (state can differ based on the story type)."},"story_id":{"type":"string","description":"`story_id` will only be included in the response if `story` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."}}}},"components/schemas/StoryTask":{"id":"components/schemas/StoryTask","kind":"json-schema","title":"Story Task","data":{"title":"Story Task","description":"A Story Task is a checklist item within a Story.","type":"object","properties":{"completed":{"type":"boolean","description":"Represents the completion of the Story Task."},"completed_at":{"type":"string","format":"date-time","description":"The time the Story Task was completed."},"completed_by_id":{"type":"string","description":"`completed_by_id` will only be included in the response if `completed_by` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time","description":"The time the Story Task was created."},"name":{"type":"string","description":"The name of the Story Task."},"position":{"type":"integer","format":"int32","description":"Represents the order of the Story Task in the list."},"story_id":{"type":"string","description":"`story_id` will only be included in the response if `story` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time","description":"The time the Story Task was last updated."}}}},"components/schemas/Submission":{"id":"components/schemas/Submission","kind":"json-schema","title":"Submission","data":{"title":"Submission","description":"Submissions contain a set of Time Entries for a specific week or Expenses for a specified time period.\nSubmission Time Entries and Expenses must be approved before they can be added to an invoice.","type":"object","properties":{"comment":{"type":"string","description":"Additional comments on the submission."},"created_at":{"type":"string","format":"date-time","description":"The date and time that the submission was created."},"currency":{"type":"string","description":"The currency of the submission."},"currency_base_unit":{"type":"integer","format":"int32","description":"The base unit of the submission's currency."},"currency_symbol":{"type":"string","description":"The symbol of the submission's currency."},"current_resolution_created_at_date":{"type":"string","format":"date-time","description":"The date and time that the submission's current resolution was created."},"current_resolution_creator_id":{"type":"integer","format":"int32","description":"The creator id on the submission's current resolution."},"current_resolution_description":{"type":"string","description":"The description on the submission's current resolution."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"line_item_total_formatted":{"type":"string","description":"A formatted total of the line items (time entries or expenses) on the submission."},"line_item_total_in_cents":{"type":"integer","format":"int32","description":"A total in cents of the line items (time entries or expenses) on the submission."},"permissions":{"type":"object","properties":{"can_cancel_submission":{"type":"boolean","description":"Can the current user cancel the submission."},"can_approve_submission":{"type":"boolean","description":"Can the current user approve the submission."},"can_reject_submission":{"type":"boolean","description":"Can the current user reject the submission."},"can_resubmit_submission":{"type":"boolean","description":"Can the current user resubmit the submission."}}},"resolution_description":{"type":"string","description":"The description on the submission's current resolution."},"status":{"type":"string","description":"The current status of the submission ('approved', 'rejected', 'cancelled', 'pending')."},"title":{"type":"string","description":"The title of the submission."},"type":{"type":"string","description":"Either an ExpenseReportSubmission or a TimesheetSubmission."},"updated_at":{"type":"string","format":"date-time","description":"The date and time that the submission was last updated."},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/SubmissionApproval":{"id":"components/schemas/SubmissionApproval","kind":"json-schema","title":"Resolution","data":{"title":"Resolution","description":"A resolution is a submission approval, rejection, or cancelation. This can be for an expense report \nsubmission or a timesheet submission.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"description":{"type":"string","description":"Additional resolution details."},"target_id":{"type":"integer","format":"int32","description":"The id of the associated submission."},"target_type":{"type":"string","description":"Whether the resolution is for a timesheet submission or an expense report submission."},"type":{"type":"string","description":"The resolution type, either approval, rejection, or cancellation."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"integer","format":"int32","description":"The id of the user who created the resolution."}}}},"components/schemas/SubmissionCancellation":{"id":"components/schemas/SubmissionCancellation","kind":"json-schema","title":"Resolution","data":{"title":"Resolution","description":"A resolution is a submission approval, rejection, or cancelation. This can be for an expense report \nsubmission or a timesheet submission.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"description":{"type":"string","description":"Additional resolution details."},"target_id":{"type":"integer","format":"int32","description":"The id of the associated submission."},"target_type":{"type":"string","description":"Whether the resolution is for a timesheet submission or an expense report submission."},"type":{"type":"string","description":"The resolution type, either approval, rejection, or cancellation."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"integer","format":"int32","description":"The id of the user who created the resolution."}}}},"components/schemas/SubmissionRejection":{"id":"components/schemas/SubmissionRejection","kind":"json-schema","title":"Resolution","data":{"title":"Resolution","description":"A resolution is a submission approval, rejection, or cancelation. This can be for an expense report \nsubmission or a timesheet submission.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"description":{"type":"string","description":"Additional resolution details."},"target_id":{"type":"integer","format":"int32","description":"The id of the associated submission."},"target_type":{"type":"string","description":"Whether the resolution is for a timesheet submission or an expense report submission."},"type":{"type":"string","description":"The resolution type, either approval, rejection, or cancellation."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"integer","format":"int32","description":"The id of the user who created the resolution."}}}},"components/schemas/SurveyAnswer":{"id":"components/schemas/SurveyAnswer","kind":"json-schema","title":"Survey Answer","data":{"title":"Survey Answer","description":"Survey Answers (Legacy) represent a user's answer to a survey question on a survey response.\nThis feature requires the Legacy Surveys account add-on. This feature is unrelated to Pulse surveys.","type":"object","properties":{"choice_ids":{"type":"array","items":{"type":"string"},"description":"`choice_ids` will only be included in the response if `choices` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time","description":"Date the survey answer was created."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"survey_question_id":{"type":"string","description":"`survey_question_id` will only be included in the response if `survey_question` is in the list of included associations. See include section for usage."},"survey_response_id":{"type":"string","description":"`survey_response_id` will only be included in the response if `survey_response` is in the list of included associations. See include section for usage."},"text":{"type":"string","description":"The text answer to the question."},"updated_at":{"type":"string","format":"date-time","description":"Date the survey answer was last updated."}}}},"components/schemas/SurveyQuestion":{"id":"components/schemas/SurveyQuestion","kind":"json-schema","title":"Survey Question","data":{"title":"Survey Question","description":"Survey Questions (Legacy) appear on and can be responded to through surveys.\nThis feature requires the Legacy Surveys account add-on. This feature is unrelated to Pulse surveys.","type":"object","properties":{"choice_ids":{"type":"array","items":{"type":"string"},"description":"`choice_ids` will only be included in the response if `choices` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time","description":"Date the survey question was created."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"question_type":{"type":"string","description":"The type of the question. Valid values: single, multi, date, string, integer, decimal."},"text":{"type":"string","description":"The text of the question asked."},"updated_at":{"type":"string","format":"date-time","description":"Date the survey question was last updated."}}}},"components/schemas/SurveyResponse":{"id":"components/schemas/SurveyResponse","kind":"json-schema","title":"Survey Response","data":{"title":"Survey Response","description":"Survey Response (Legacy) represents an instance of a particular survey that has been assigned for response.\nThis feature requires the Legacy Surveys account add-on. This feature is unrelated to Pulse surveys.","type":"object","properties":{"close_date":{"type":"string","format":"date","description":"The close date for this survey."},"created_at":{"type":"string","format":"date-time","description":"Date the survey response was created."},"description":{"type":"string","description":"The description of the survey."},"due_date":{"type":"string","format":"date","description":"The due date for this survey."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"open_date":{"type":"string","format":"date","description":"The open date for this survey."},"owner_id":{"type":"string","description":"`owner_id` will only be included in the response if `owner` is in the list of included associations. See include section for usage."},"respondent_id":{"type":"string","description":"`respondent_id` will only be included in the response if `respondent` is in the list of included associations. See include section for usage."},"status":{"type":"string","description":"The status of the survey response."},"subject_ref":{"type":"object","description":"`subject_ref` will only be included in the response if `subject` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"survey_answer_ids":{"type":"array","items":{"type":"string"},"description":"`survey_answer_ids` will only be included in the response if `survey_answers` is in the list of included associations. See include section for usage."},"survey_template_id":{"type":"string","description":"`survey_template_id` will only be included in the response if `survey_template` is in the list of included associations. See include section for usage."},"title":{"type":"string","description":"The title of the survey."},"updated_at":{"type":"string","format":"date-time","description":"Date the survey response was last updated."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/SurveyTemplate":{"id":"components/schemas/SurveyTemplate","kind":"json-schema","title":"Survey Template","data":{"title":"Survey Template","description":"Survey Templates (Legacy) define a set a questions for which survey responses can be created from.\nThis feature requires the Legacy Surveys account add-on. This feature is unrelated to Pulse surveys.","type":"object","properties":{"close_date":{"type":"string","format":"date","description":"The close date to be used for surveys based on this template."},"created_at":{"type":"string","format":"date-time","description":"Date the survey template was created."},"description":{"type":"string","description":"Description of the survey."},"due_date":{"type":"string","format":"date","description":"The due date to be used for surveys based on this template."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"open_date":{"type":"string","format":"date","description":"The open date to be used for surveys based on this template."},"owner_id":{"type":"string","description":"`owner_id` will only be included in the response if `owner` is in the list of included associations. See include section for usage."},"respondent_id":{"type":"string","description":"`respondent_id` will only be included in the response if `respondent` is in the list of included associations. See include section for usage."},"subject_ref":{"type":"object","description":"`subject_ref` will only be included in the response if `subject` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"survey_question_ids":{"type":"array","items":{"type":"string"},"description":"`survey_question_ids` will only be included in the response if `survey_questions` is in the list of included associations. See include section for usage."},"survey_response_ids":{"type":"array","items":{"type":"string"},"description":"`survey_response_ids` will only be included in the response if `survey_responses` is in the list of included associations. See include section for usage."},"title":{"type":"string","description":"The title of the survey."},"updated_at":{"type":"string","format":"date-time","description":"Date the survey template was last updated."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/TimeEntry":{"id":"components/schemas/TimeEntry","kind":"json-schema","title":"Time Entry","data":{"title":"Time Entry","description":"This object allows you to manage Kantata OX time entries, depending on your permissions.\nCreating and updating time entries allows you to include time when invoicing clients.","type":"object","properties":{"active_submission_id":{"type":"string","description":"`active_submission_id` will only be included in the response if `active_submission` is in the list of included associations. See include section for usage."},"approved":{"type":"boolean","description":"Specifies whether the time entry has been approved."},"billable":{"type":"boolean","description":"Whether the work for the time entry is billable."},"cost_rate_in_cents":{"type":"integer","format":"int32","description":"Cost to perform the work in time entry's currency per hour."},"created_at":{"type":"string","format":"date-time","description":"Date the time entry was created, but not necessarily when the work was performed.\n The work can be performed at a different time."},"currency":{"type":"string","description":"Currency of the project when the time entry was made."},"currency_base_unit":{"type":"integer","format":"int32","description":"The number of subunits to make a regular unit of time entries currency."},"currency_symbol":{"type":"string","description":"Symbol for the currency of the time entry."},"date_performed":{"type":"string","format":"date","description":"Date the time entry work was performed by the specified user."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"invoice_id":{"type":"string","description":"`invoice_id` will only be included in the response if `invoice` is in the list of included associations. See include section for usage."},"is_invoiced":{"type":"boolean","description":"Specifies whether the time entry has been invoiced."},"location":{"type":"string","description":"The location of the time entry.\nVisible when the account has locations."},"location_id":{"type":"integer","format":"int32","description":"The location id of the time entry.\nVisible when the account has locations.\n\nOnly returned when requested through the optional_fields param."},"notes":{"type":"string","description":"Notes about the time entries work."},"rate_in_cents":{"type":"integer","format":"int32","description":"Billable rate for the work in time entry currency's cents per hour."},"recent_submission_id":{"type":"string","description":"`recent_submission_id` will only be included in the response if `recent_submission` is in the list of included associations. See include section for usage."},"role_id":{"type":"string","description":"`role_id` will only be included in the response if `role` is in the list of included associations. See include section for usage."},"story_id":{"type":"string","description":"`story_id` will only be included in the response if `story` is in the list of included associations. See include section for usage."},"taxable":{"type":"boolean","description":"Specifies whether the time entry is taxable."},"time_in_minutes":{"type":"integer","format":"int32","description":"Amount of work that was performed in minutes."},"updated_at":{"type":"string","format":"date-time","description":"Date the time entry was last updated."},"user_can_edit":{"type":"boolean","description":"Returns true if the requesting user can edit the time entry.\nOnly returned when requested through the optional_fields param."},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/TimeOffEntry":{"id":"components/schemas/TimeOffEntry","kind":"json-schema","title":"Time Off Entry","data":{"title":"Time Off Entry","description":"A Time Off Entry represents the number of hours a specific user has scheduled off for a requested date.","type":"object","properties":{"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"hours":{"type":"number","format":"float","description":"The number of hours of time off for the requested date."},"requested_date":{"type":"string","format":"date","description":"The date for which time off is requested."},"role_id":{"type":"string","description":"`role_id` will only be included in the response if `role` is in the list of included associations. See include section for usage."},"submission_date":{"type":"string","format":"date","description":"The date on which the time off was submitted."},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."}}}},"components/schemas/TimesheetSubmission":{"id":"components/schemas/TimesheetSubmission","kind":"json-schema","title":"Timesheet Submission","data":{"title":"Timesheet Submission","description":"Timesheet Submissions contain a set of Time Entries for a specific week. These Time Entries must be\napproved through a Timesheet Submission before creating an invoice.","type":"object","properties":{"comment":{"type":"string","description":"Additional comments on the submission."},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string","description":"The currency of the submission."},"currency_base_unit":{"type":"integer","format":"int32","description":"The base unit of the submission's currency."},"currency_symbol":{"type":"string","description":"The symbol of the submission's currency."},"current_resolution_created_at_date":{"type":"string","format":"date-time","description":"The date and time that the submission's current resolution was created."},"current_resolution_creator_id":{"type":"integer","format":"int32","description":"The creator id on the submission's current resolution."},"current_resolution_description":{"type":"string","description":"The description on the submission's current resolution."},"end_date":{"type":"string","format":"date","description":"The last day of the week."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"line_item_total_formatted":{"type":"string","description":"A formatted total of the line items (time entries or expenses) on the submission."},"line_item_total_in_cents":{"type":"integer","format":"int32","description":"A total in cents of the line items (time entries or expenses) on the submission."},"permissions":{"type":"object","properties":{"can_cancel_submission":{"type":"boolean","description":"Can the current user cancel the submission."},"can_approve_submission":{"type":"boolean","description":"Can the current user approve the submission."},"can_reject_submission":{"type":"boolean","description":"Can the current user reject the submission."},"can_resubmit_submission":{"type":"boolean","description":"Can the current user resubmit the submission."}}},"resolution_description":{"type":"string","description":"The description on the submission's current resolution."},"start_date":{"type":"string","format":"date","description":"The first day of the week."},"status":{"type":"string","description":"The current status of the submission ('approved', 'rejected', 'cancelled', 'pending')."},"time_entry_ids":{"type":"array","items":{"type":"string"},"description":"`time_entry_ids` will only be included in the response if `time_entries` is in the list of included associations. See include section for usage."},"title":{"type":"string","description":"The title of the submission."},"type":{"type":"string","description":"Either an ExpenseReportSubmission or a TimesheetSubmission."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"title":"User","description":"Users represent the individuals that are participating in Kantata OX projects. User objects are often returned as\nnested JSON objects within other returned items such as Posts or Stories.","type":"object","properties":{"abbreviated_timezone":{"type":"string","description":"The abbreviation for the user's time zone.\nOnly returned when requested through the optional_fields param."},"account_membership_id":{"type":"string","description":"`account_membership_id` will only be included in the response if `account_membership` is in the list of included associations. See include section for usage."},"bio":{"type":"string","description":"A biography (defined by the user).\nOnly returned when requested through the optional_fields param."},"city":{"type":"string","description":"The home city of the user (based on their profile).\nOnly returned when requested through the optional_fields param."},"classification":{"type":"string","description":"Indicates whether a user is Internal or External.\nOnly returned when requested through the optional_fields param."},"country":{"type":"string","description":"The home country of the user (based on their profile).\nOnly returned when requested through the optional_fields param."},"custom_field_value_ids":{"type":"array","items":{"type":"string"},"description":"`custom_field_value_ids` will only be included in the response if `custom_field_values` is in the list of included associations. See include section for usage."},"email_address":{"type":"string","description":"The email address of the user."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"full_name":{"type":"string","description":"The full name of the user."},"headline":{"type":"string","description":"A short description of the user."},"last_site_activity":{"type":"string","format":"date-time","description":"The last time a user logged in. This field is only available in conjunction with the `on_my_account` filter option. Only visible when the API user is an Account Administrator.\nOnly returned when requested through the optional_fields param."},"manager_id":{"type":"string","description":"`manager_id` will only be included in the response if `manager` is in the list of included associations. See include section for usage."},"photo_path":{"type":"string","description":"The URL of the user's profile photo."},"role_id":{"type":"string","description":"`role_id` will only be included in the response if `role` is in the list of included associations. See include section for usage."},"skill_ids":{"type":"array","items":{"type":"string"},"description":"`skill_ids` will only be included in the response if `skills` is in the list of included associations. See include section for usage."},"skill_membership_ids":{"type":"array","items":{"type":"string"},"description":"`skill_membership_ids` will only be included in the response if `skill_memberships` is in the list of included associations. See include section for usage."},"state":{"type":"string","description":"The home state of the user (based on their profile).\nOnly returned when requested through the optional_fields param."},"website":{"type":"string","description":"A website (defined by the user).\nOnly returned when requested through the optional_fields param."},"work_sample_ids":{"type":"array","items":{"type":"string"},"description":"`work_sample_ids` will only be included in the response if `work_samples` is in the list of included associations. See include section for usage."}}}},"components/schemas/UserFileAssociation":{"id":"components/schemas/UserFileAssociation","kind":"json-schema","title":"User File Association","data":{"title":"User File Association","description":"User File Associations act as a join object between a user, project, and\nan attachment (or Google document).","type":"object","properties":{"asset_object_ref":{"type":"object","description":"`asset_object_ref` will only be included in the response if `asset_object` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"post_id":{"type":"string","description":"`post_id` will only be included in the response if `post` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/UserWorkspaceGroup":{"id":"components/schemas/UserWorkspaceGroup","kind":"json-schema","title":"User Group Membership","data":{"title":"User Group Membership","description":"A User Group Membership represents the connection of a user to a [Workspace Group](/tag/Workspace-Groups).","type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"When the user was assigned to the Workspace Group."},"creator_id":{"type":"integer","format":"int32","description":"The ID of the user that assigned the associated user to the Workspace Group."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user that is assigned to the Workspace Group."},"workspace_group_id":{"type":"integer","format":"int32","description":"The ID of the Workspace Group the user is assigned to."}}}},"components/schemas/Vendor":{"id":"components/schemas/Vendor","kind":"json-schema","title":"Vendor","data":{"title":"Vendor","description":"A Vendor is an entity to which an expense can be paid.","type":"object","properties":{"archived":{"type":"boolean","description":"Whether the vendor is archived."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"externally_managed":{"type":"boolean","description":"Whether the vendor was created by an external system and then imported."},"in_use":{"type":"boolean","description":"Whether the vendor is used on an invoice."},"name":{"type":"string","description":"The name of the vendor."}}}},"components/schemas/WorkSample":{"id":"components/schemas/WorkSample","kind":"json-schema","title":"Work Sample","data":{"title":"Work Sample","type":"object","properties":{"attachment_filename":{"type":"string"},"attachment_id":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"trapped_website_url":{"type":"string","description":"Redirected version of a work sample url."},"website_url":{"type":"string"}}}},"components/schemas/Workspace":{"id":"components/schemas/Workspace","kind":"json-schema","title":"Workspace","data":{"title":"Workspace","description":"Workspaces (also called projects) represent the space in which Kantata OX users plan, communicate, and collaborate.","type":"object","properties":{"access_level":{"type":"string","description":"Whether the project is open, and who can join it. Possible values are `invitation`, `open`, and `admin`."},"account_color_id":{"type":"string","description":"`account_color_id` will only be included in the response if `account_color` is in the list of included associations. See include section for usage."},"account_id":{"type":"integer","format":"int32","description":"The ID of the account which the project is in."},"account_insights_mapping_ids":{"type":"array","items":{"type":"string"},"description":"`account_insights_mapping_ids` will only be included in the response if `account_insights_mappings` is in the list of included associations. See include section for usage."},"actual_fees_includes_additional_line_items":{"type":"boolean","description":"Whether invoice additional items are included in actual fees calculations for the project.\nVisible when the authenticated user is a project administrator and is on the account that the project is on."},"actual_fees_includes_expenses":{"type":"boolean","description":"Whether expenses are included in actual fees calculations for the project.\nVisible when the authenticated user is a project administrator and is on the account that the project is on."},"approver_id":{"type":"string","description":"`approver_id` will only be included in the response if `approver` is in the list of included associations. See include section for usage."},"approver_ids":{"type":"array","items":{"type":"string"},"description":"`approver_ids` will only be included in the response if `approvers` is in the list of included associations. See include section for usage."},"archived":{"type":"boolean","description":"Whether the project is archived."},"billable_minutes":{"type":"integer","format":"int32","description":"The total amount of billable time entries, in minutes. Only visible if the authenticated user has financial access in the project and is on the provider team.\nVisible when the authenticated user can see total time approved in the project.\n\nOnly returned when requested through the optional_fields param."},"billing_milestone_ids":{"type":"array","items":{"type":"string"},"description":"`billing_milestone_ids` will only be included in the response if `billing_milestones` is in the list of included associations. See include section for usage."},"budget_remaining":{"type":"string","description":"The amount of the project budget remaining.\nVisible when the authenticated user is on the provider team and can either see reports on the account or has financial access in the project."},"budget_used":{"type":"string","description":"The amount of the project budget that has been used.\nVisible when the authenticated user is on the provider team and can either see reports on the account or has financial access in the project."},"budget_used_in_cents":{"type":"integer","format":"int32","description":"The amount of the project budget that has been used, in the subunits of the currency (e.g. cents for USD).\nVisible when the authenticated user is on the provider team and can either see reports on the account or has financial access in the project."},"budgeted":{"type":"boolean","description":"Whether the project is budgeted."},"can_create_line_items":{"type":"boolean","description":"Whether the authenticated user can create line items in the project (i.e. time entries, expenses, fixed fee items, or additional items)."},"can_invite":{"type":"boolean","description":"Whether the authenticated user can invite others to the project."},"change_orders_enabled":{"type":"boolean","description":"Whether change orders are enabled in the project."},"client_lead_name":{"type":"string","description":"The name of the team lead for the client side of the project.\nOnly returned when requested through the optional_fields param."},"client_role_name":{"type":"string","description":"The client team name."},"consultant_role_name":{"type":"string","description":"The provider team name."},"created_at":{"type":"string","format":"date-time","description":"The date the project was created."},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"currency":{"type":"string","description":"The currency of the project. Only visible if the authenticated user has financial access in the project."},"currency_base_unit":{"type":"integer","format":"int32","description":"The base unit of the currency of the project. For example, the base unit for USD is 100."},"currency_symbol":{"type":"string","description":"The [ISO symbol](https://knowledge.kantata.com/hc/en-us/articles/360041576473) for the currency of the project. For example, `USD`."},"current_status_report_id":{"type":"string","description":"`current_status_report_id` will only be included in the response if `current_status_report` is in the list of included associations. See include section for usage."},"current_user_participation_id":{"type":"string","description":"`current_user_participation_id` will only be included in the response if `current_user_participation` is in the list of included associations. See include section for usage."},"custom_field_value_ids":{"type":"array","items":{"type":"string"},"description":"`custom_field_value_ids` will only be included in the response if `custom_field_values` is in the list of included associations. See include section for usage."},"default_rate":{"type":"string","description":"The default billing rate for the project."},"description":{"type":"string","description":"The description of the project."},"due_date":{"type":"string","format":"date","description":"The due date of the project."},"effective_due_date":{"type":"string","format":"date","description":"The due date of the project (deprecated)."},"estimated_minutes":{"type":"integer","format":"int32","description":"The total task estimated minutes of the project.\nVisible when the authenticated user can see reports on the account or has financial access in the project.\n\nOnly returned when requested through the optional_fields param."},"exclude_archived_stories_percent_complete":{"type":"boolean","description":"Whether archived tasks are excluded from the calculation of the project completion percentage."},"expenses_in_burn_rate":{"type":"boolean","description":"Whether both expenses and invoice additional items are included in the actual fees calculation for the project. This field is the `AND` of `actual_fees_includes_expenses` and `actual_fees_includes_additional_line_items`.\nVisible when the authenticated user is a project administrator and is on the account that the project is on."},"external_link":{"type":"object","description":"A link that displays within the project workspace. Requires the Project Button facilitated feature.\nVisible when the workspace has the project button feature enabled.","properties":{"url":{"type":"string","description":"The URL of the link.\nVisible when the workspace has the project button feature enabled."},"text":{"type":"string","description":"The button text.\nVisible when the workspace has the project button feature enabled."}}},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"financial_viewer_ids":{"type":"array","items":{"type":"string"},"description":"`financial_viewer_ids` will only be included in the response if `financial_viewers` is in the list of included associations. See include section for usage."},"has_active_expense_report_submissions":{"type":"boolean","description":"Whether the project has active expense report submissions."},"has_active_timesheet_submissions":{"type":"boolean","description":"Whether the project has active timesheet submissions."},"has_budget_access":{"type":"boolean","description":"Whether the authenticated user has budget access in the project."},"incoming_email_address":{"type":"string","description":"The email address for the project—unique to the authenticated user—which can be used to post to the project's Activity Feed via email.\nVisible when the authenticated user is a project administrator and is on the account that the project is on.\n\nOnly returned when requested through the optional_fields param."},"lock_date":{"type":"string","format":"date","description":"The line item lock date for the account the project is on, if any.\nOnly returned when requested through the optional_fields param."},"minutes_logged":{"type":"integer","format":"int32","description":"The total minutes logged on the project, including time adjustments. Only visible if the authenticated user has financial access in the project and is on the provider team.\nVisible when the authenticated user can see total time approved in the project.\n\nOnly returned when requested through the optional_fields param."},"next_uncompleted_milestone_id":{"type":"string","description":"`next_uncompleted_milestone_id` will only be included in the response if `next_uncompleted_milestone` is in the list of included associations. See include section for usage."},"non_billable_minutes":{"type":"integer","format":"int32","description":"The total of all non-billable time entries in minutes, only included if the current user has financial access and is a maven in the project.\nVisible when the authenticated user can see total time approved in the project.\n\nOnly returned when requested through the optional_fields param."},"over_budget":{"type":"boolean","description":"Whether the project is over budget. Only visible if the authenticated user has financial access in the project.\nVisible when the authenticated user is a project administrator and is on the account that the project is on."},"participant_ids":{"type":"array","items":{"type":"string"},"description":"`participant_ids` will only be included in the response if `participants` is in the list of included associations. See include section for usage."},"participation_ids":{"type":"array","items":{"type":"string"},"description":"`participation_ids` will only be included in the response if `participations` is in the list of included associations. See include section for usage."},"percent_of_budget_used":{"type":"integer","format":"int32","description":"The percent of the project budget used.\nVisible when the authenticated user is on the provider team and can either see reports on the account or has financial access in the project."},"percentage_complete":{"type":"integer","format":"int32","description":"The completion percentage of the project, calculated from the completion percentage of the stories (tasks), including archived stories."},"permissions":{"type":"object","description":"Various project permissions for the authenticated user.","properties":{"can_upload_files":{"type":"boolean","description":"Whether the authenticated user can upload files to the project."},"can_private_message":{"type":"boolean","description":"Whether the authenticated user can send private messages in the project."},"can_join":{"type":"boolean","description":"Whether the authenticated user can join the project."},"is_participant":{"type":"boolean","description":"Whether the authenticated user is participating in the project."},"access_level":{"type":"string","description":"The authenticated user’s permission level in the project."},"team_lead":{"type":"boolean","description":"Whether the authenticated user is a team lead in the project."},"user_is_client":{"type":"boolean","description":"Whether the authenticated user is a client in the project."},"can_change_price":{"type":"boolean","description":"Whether the authenticated user can change the price (budget) of the project."},"can_change_story_billable":{"type":"boolean","description":"Whether the authenticated user can change the billable status of stories (tasks) in the project."},"can_post":{"type":"boolean","description":"Whether the authenticated user has post permissions in the project."},"can_edit":{"type":"boolean","description":"Whether the authenticated user has edit permissions in the project."},"restricted":{"type":"boolean","description":"Whether the authenticated user is a restricted user in the project."},"can_see_financials":{"type":"boolean","description":"Whether the authenticated user has financial access in the project."},"is_guest_on_project":{"type":"boolean","description":"Returns true if the authenticated user can view projects without joining. Otherwise, returns false."}}},"possible_approver_ids":{"type":"array","items":{"type":"string"},"description":"`possible_approver_ids` will only be included in the response if `possible_approvers` is in the list of included associations. See include section for usage."},"posts_require_privacy_decision":{"type":"boolean","description":"Whether posts are private (`true`) or shared with all project participants (`false`) by default."},"price":{"type":"string","description":"The project budget.\nVisible when the authenticated user can see reports on the account or has financial access in the project."},"price_in_cents":{"type":"integer","format":"int32","description":"The project budget, in the subunits of the currency (e.g. cents for USD).\nVisible when the authenticated user can see reports on the account or has financial access in the project."},"primary_counterpart_id":{"type":"string","description":"`primary_counterpart_id` will only be included in the response if `primary_counterpart` is in the list of included associations. See include section for usage."},"primary_maven_id":{"type":"string","description":"`primary_maven_id` will only be included in the response if `primary_maven` is in the list of included associations. See include section for usage."},"primary_workspace_group_id":{"type":"string","description":"`primary_workspace_group_id` will only be included in the response if `primary_workspace_group` is in the list of included associations. See include section for usage."},"provider_lead_name":{"type":"string","description":"The name of the team lead for the provider side of the project.\nOnly returned when requested through the optional_fields param."},"rate_card_id":{"type":"integer","format":"int32","description":"The ID of the rate card for the project."},"require_expense_approvals":{"type":"boolean","description":"Whether expense approvals are required in the project."},"require_notes_on_time_entries":{"type":"boolean","description":"Whether notes are required on time entries logged against this project."},"require_time_approvals":{"type":"boolean","description":"Whether time approvals are required in the project."},"revenue_recognition_method_id":{"type":"string","description":"The ID of the project's revenue recognition method, which determines how the project's revenue is recognized and accounted for. The ID is a composite ID made up of a numerical ID (unique to each account), a colon, and the method type. For example `123:percent_complete`.\nOnly returned when requested through the optional_fields param."},"revenue_recognition_method_name":{"type":"string","description":"The name of the project's revenue recognition method, which determines how the project's revenue is recognized and accounted for.\nOnly returned when requested through the optional_fields param."},"stage":{"type":"string","description":"The stage of the project. Possible values are `estimate` or `project`.\nOnly returned when requested through the optional_fields param."},"start_date":{"type":"string","format":"date","description":"The start date of the project."},"status":{"type":"object","description":"A hash containing the status of the project.\nVisible when the authenticated user can view the project status.","properties":{"color":{"type":"string","description":"The status color of the project (e.g. 'red').\nVisible when the authenticated user can view the project status."},"key":{"type":"string","description":"The status key of the project (e.g. '501').\nVisible when the authenticated user can view the project status."},"message":{"type":"string","description":"The status message of the project (e.g. 'Cancelled').\nVisible when the authenticated user can view the project status."}}},"status_report_ids":{"type":"array","items":{"type":"string"},"description":"`status_report_ids` will only be included in the response if `status_reports` is in the list of included associations. See include section for usage."},"stories_are_fixed_fee_by_default":{"type":"boolean","description":"Whether stories (tasks) are fixed fee by default.\nVisible when the authenticated user is a project administrator and is on the account that the project is on."},"target_margin":{"type":"number","format":"float","description":"The target margin of the project.\nVisible when the authenticated user is on the provider team and can either see reports on the account or has financial access in the project."},"task_status_set_id":{"type":"string","description":"The ID of the task status set assigned to the workspace."},"task_status_set_name":{"type":"string","description":"The name of the task status set assigned to the workspace."},"task_statuses":{"type":"array","items":{"type":"string"},"description":"The task statuses available in the workspace."},"tasks_default_non_billable":{"type":"boolean","description":"Whether stories (tasks) are non-billable by default."},"time_trackable":{"type":"boolean","description":"Whether time can be tracked against this project and its tasks."},"timesheet_submission_ids":{"type":"array","items":{"type":"string"},"description":"`timesheet_submission_ids` will only be included in the response if `timesheet_submissions` is in the list of included associations. See include section for usage."},"title":{"type":"string","description":"The title of the project."},"total_expenses_in_cents":{"type":"integer","format":"int32","description":"The total amount of expenses on the project, in the subunits of the currency (e.g. cents for USD).\nVisible when the authenticated user is a project administrator and is on the account that the project is on."},"total_invoiced":{"type":"string","description":"The total amount invoiced, in the subunits of the currency (e.g. cents for USD).\nVisible when the authenticated user can see reports on the account or has financial access in the project.\n\nOnly returned when requested through the optional_fields param."},"total_minutes_approved":{"type":"integer","format":"int32","description":"The total amount of approved time entries, in minutes. Only visible if the authenticated user has financial access in the project and is on the provider team.\nVisible when the authenticated user can see total time approved in the project.\n\nOnly returned when requested through the optional_fields param."},"updated_at":{"type":"string","format":"date-time","description":"The date that the project was last updated."},"workspace_group_ids":{"type":"array","items":{"type":"string"},"description":"`workspace_group_ids` will only be included in the response if `workspace_groups` is in the list of included associations. See include section for usage."},"workspace_invoice_preference_id":{"type":"integer","format":"int32","description":"The ID of the workspace invoice preference which the project is associated with."},"workspace_resource_ids":{"type":"array","items":{"type":"string"},"description":"`workspace_resource_ids` will only be included in the response if `workspace_resources` is in the list of included associations. See include section for usage."},"workspace_resources_with_unnamed_ids":{"type":"array","items":{"type":"string"},"description":"`workspace_resources_with_unnamed_ids` will only be included in the response if `workspace_resources_with_unnamed` is in the list of included associations. See include section for usage."}}}},"components/schemas/WorkspaceAllocation":{"id":"components/schemas/WorkspaceAllocation","kind":"json-schema","title":"Workspace Allocation","data":{"title":"Workspace Allocation","description":"A workspace allocation represents a resource’s allocation over a specific period of time,\nand is always associated with a workspace resource.\n\n*Note:* When an allocation is split, two allocations are returned in the response.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"end_date":{"type":"string","format":"date","description":"The date the allocation ends on."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"hard":{"type":"boolean","description":"Indicates if the allocation is a Hard Allocation (“true”) or Soft (“false”)."},"minutes":{"type":"integer","format":"int32","description":"Total minutes the resource is allocated over the date range."},"notes":{"type":"string","description":"User entered notes about the allocation."},"percentage":{"type":"number","format":"float","description":"Percentage that a user is allocated compared to their capacity between the start and end date of the allocation."},"start_date":{"type":"string","format":"date","description":"The date the allocation starts on."},"updated_at":{"type":"string","format":"date-time"},"updater_id":{"type":"string","description":"`updater_id` will only be included in the response if `updater` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."},"workspace_resource_id":{"type":"string","description":"The ID of the workspace resource that the allocation will be associated with."}}}},"components/schemas/WorkspaceBaseline":{"id":"components/schemas/WorkspaceBaseline","kind":"json-schema","title":"Workspace Baseline","data":{"title":"Workspace Baseline","description":"A Gantt workspace baseline is composed of a workspace’s aggregate data at the time of the baseline creation.\n\nA workspace baseline has an associated baseline payload.","type":"object","properties":{"budget_used_formatted":{"type":"string","description":"\nVisible when the API user can view task budgets."},"budget_used_in_cents":{"type":"integer","format":"int32","description":"\nVisible when the API user can view task budgets."},"completed_stories":{"type":"integer","format":"int32"},"created_at":{"type":"string","format":"date-time"},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"creator_name":{"type":"string"},"currency_base_unit":{"type":"integer","format":"int32","description":"E.g. 100 (as in, 100 cents for 1 USD dollar).\nVisible when the API user can view task budgets."},"currency_symbol":{"type":"string","description":"E.g. USD.\nVisible when the API user can view task budgets."},"description":{"type":"string"},"due_date":{"type":"string","format":"date"},"payload_id":{"type":"string","description":"`payload_id` will only be included in the response if `payload` is in the list of included associations. See include section for usage."},"percentage_complete":{"type":"integer","format":"int32"},"projected_due_date":{"type":"string","format":"date"},"status_color":{"type":"string","description":"The color of the workspace's status.\nVisible when the API user can view project statuses."},"status_text":{"type":"string","description":"The text of the workspace's status.\nVisible when the API user can view project statuses."},"title":{"type":"string"},"total_budget_formatted":{"type":"string","description":"\nVisible when the API user can view task budgets."},"total_budget_in_cents":{"type":"integer","format":"int32","description":"\nVisible when the API user can view task budgets."},"total_stories":{"type":"integer","format":"int32"},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/WorkspaceGroup":{"id":"components/schemas/WorkspaceGroup","kind":"json-schema","title":"Workspace Group","data":{"title":"Workspace Group","description":"Workspace Groups (also known as groups) allow for the categorization of Kantata OX Workspaces and Users. Workspace Groups are unique to each Kantata OX Account. These endpoints allow you to fetch, create, update, and delete Workspace Groups.\n\nTo add a workspace to a Workspace Group, use the [create workspace](/tag/Workspaces#operation/create-workspace) or [update workspace](/tag/Workspaces#operation/update-workspace) endpoint and set the `workspace_group_ids` field.\n\nTo add a user to a Workspace Group, use the [create user group membership](/tag/User-Group-Memberships#operation/create-user-group-memberships) endpoint.","type":"object","properties":{"address":{"type":"string","description":"The address of the company contact."},"company":{"type":"boolean","description":"Whether the group represents a company."},"contact_name":{"type":"string","description":"The name of the company contact."},"created_at":{"type":"string","format":"date-time","description":"When the group was created."},"email":{"type":"string","description":"The email of the company contact."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"name":{"type":"string","description":"The name of the group."},"notes":{"type":"string","description":"Notes on the group."},"phone_number":{"type":"string","description":"The phone number of the company contact."},"rate_card_set_ids":{"type":"array","items":{"type":"string"},"description":"`rate_card_set_ids` will only be included in the response if `rate_card_sets` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time","description":"When the group was last updated."},"website":{"type":"string","description":"The website of the company contact."},"workspace_ids":{"type":"array","items":{"type":"string"},"description":"`workspace_ids` will only be included in the response if `workspaces` is in the list of included associations. See include section for usage."}}}},"components/schemas/WorkspaceInvitation":{"id":"components/schemas/WorkspaceInvitation","kind":"json-schema","title":"Workspace Invitation","data":{"title":"Workspace Invitation","type":"object","properties":{"email_address":{"type":"string"},"full_name":{"type":"string"},"invitee_role":{"type":"string"},"message":{"type":"string"},"subject":{"type":"string"}}}},"components/schemas/WorkspaceInvoicePreference":{"id":"components/schemas/WorkspaceInvoicePreference","kind":"json-schema","title":"Workspace Invoice Preference","data":{"title":"Workspace Invoice Preference","description":"Workspace Invoice Preferences specify the default values to be applied to new invoices created for specified \nprojects. It is only used for projects that have financials enabled.\n\nThese preferences can only be created and updated by users who can manage invoice preferences\non the project. This can be found by querying `can_manage_invoice_preferences` on Workspace.","type":"object","properties":{"client_invoice_address":{"type":"string","description":"The address of the client being invoiced."},"client_invoice_name":{"type":"string","description":"The name of the client being invoiced."},"consultant_invoice_address":{"type":"string","description":"The address of the provider who is sending the invoice."},"consultant_invoice_name":{"type":"string","description":"The name of the provider who is sending the invoice."},"project_code":{"type":"string","description":"The invoice project code (defined by the user)."},"purchase_order":{"type":"string","description":"The invoice purchase order (defined by the user)."},"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project for which the invoice preferences will apply."}}}},"components/schemas/WorkspacePost":{"id":"components/schemas/WorkspacePost","kind":"json-schema","title":"Post","data":{"title":"Post","description":"A Post represents a message written by participants in a project that appears in the project.","type":"object","properties":{"attachment_ids":{"type":"array","items":{"type":"string"},"description":"`attachment_ids` will only be included in the response if `attachments` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time"},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"formatted_message":{"type":"string","description":"Sanitized HTML representation of the message with links, user mentions and emoji images."},"google_document_ids":{"type":"array","items":{"type":"string"},"description":"`google_document_ids` will only be included in the response if `google_documents` is in the list of included associations. See include section for usage."},"has_attachments":{"type":"boolean","description":"Whether the post contains any attachments."},"message":{"type":"string","description":"The message of the post."},"newest_reply_at":{"type":"string","format":"date-time","description":"The date and time of the most recent reply."},"newest_reply_id":{"type":"string","description":"`newest_reply_id` will only be included in the response if `newest_reply` is in the list of included associations. See include section for usage."},"newest_reply_user_id":{"type":"string","description":"`newest_reply_user_id` will only be included in the response if `newest_reply_user` is in the list of included associations. See include section for usage."},"parsed_message":{"type":"string","description":"Based on the markdown preference, includes either the parsed markdown or the message."},"private":{"type":"boolean","description":"Whether the post is private."},"recipient_ids":{"type":"array","items":{"type":"string"},"description":"`recipient_ids` will only be included in the response if `recipients` is in the list of included associations. See include section for usage."},"reply":{"type":"boolean","description":"Whether there are any replies to the post."},"reply_count":{"type":"integer","format":"int32","description":"The number of replies to the post."},"reply_ids":{"type":"array","items":{"type":"string"},"description":"`reply_ids` will only be included in the response if `replies` is in the list of included associations. See include section for usage."},"story_id":{"type":"string","description":"`story_id` will only be included in the response if `story` is in the list of included associations. See include section for usage."},"subject_id":{"type":"integer","format":"int32","description":"Whether the post is a reply, the internal ID of the parent post, or the object to which the reply is made."},"subject_ref":{"type":"object","description":"`subject_ref` will only be included in the response if `subject` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"subject_title":{"type":"string","description":"The subject title for proof posts."},"subject_type":{"type":"string","description":"The class name of the object to which the reply is made."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/WorkspaceResource":{"id":"components/schemas/WorkspaceResource","kind":"json-schema","title":"Workspace Resource","data":{"title":"Workspace Resource","description":"With workspace resources it is possible for a user to have many resources with different roles\nwithin a single workspace. Workspace resource can be assigned to tasks via Assignments which\nenables specifying a specific role / rate per assigned task.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"custom_field_value_ids":{"type":"array","items":{"type":"string"},"description":"`custom_field_value_ids` will only be included in the response if `custom_field_values` is in the list of included associations. See include section for usage."},"display_label":{"type":"string","description":"User facing Identifer for the Resource."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"full_name":{"type":"string","description":"Full Name of the Resource's user if any."},"label":{"type":"string"},"organization_membership_id":{"type":"string","description":"`organization_membership_id` will only be included in the response if `organization_membership` is in the list of included associations. See include section for usage."},"participation_id":{"type":"string","description":"`participation_id` will only be included in the response if `participation` is in the list of included associations. See include section for usage."},"photo_path":{"type":"string","description":"URI of the Workspace Resource User Profile Photo if there is an user of the Resource."},"resource_bill_rate":{"type":"integer","format":"int32","description":"The bill rate of the resource in a project, in the subunits of the currency (e.g. cents for USD).\nIf the resource's bill rate was overridden for the project, this field returns the overridden rate.\n\nIncluding this field in your request may result in a slower response. We recommend including this field only if necessary.\nVisible when the authenticated user has financial access in the project and is on the provider team.\n\nOnly returned when requested through the optional_fields param."},"resource_cost_rate":{"type":"integer","format":"int32","description":"The cost rate of the resource in a project, in the subunits of the currency (e.g. cents for USD).\nIf the resource's cost rate was overridden for the project, this field returns the overridden rate.\n\nIncluding this field in your request may result in a slower response. We recommend including this field only if necessary.\nVisible when the authenticated user has financial access in the project and is on the provider team.\n\nOnly returned when requested through the optional_fields param."},"role_id":{"type":"string","description":"`role_id` will only be included in the response if `role` is in the list of included associations. See include section for usage."},"role_initials":{"type":"string","description":"Three letter initals for the Resource's Role if any."},"role_name":{"type":"string","description":"Name of the Resource's role if any."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"integer","format":"int32","description":"Id of the Workspace that the Resource belongs to."},"workspace_title":{"type":"string","description":"Title of the Workspace that the Resource belongs to."}}}},"components/schemas/WorkspaceResourceSkill":{"id":"components/schemas/WorkspaceResourceSkill","kind":"json-schema","title":"Workspace Resource Skill","data":{"title":"Workspace Resource Skill","description":"A Workspace Resource Skill represents a skill that has been assigned to a workspace resource.","type":"object","properties":{"cached_skill_name":{"type":"string","description":"The name of the skill."},"created_at":{"type":"string","format":"date-time"},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"level":{"type":"integer","format":"int32","description":"The objects proficiency level for the skill (1-5)."},"max_level":{"type":"integer","format":"int32","description":"The maximum level assigned for the skill."},"skill_id":{"type":"string","description":"`skill_id` will only be included in the response if `skill` is in the list of included associations. See include section for usage."},"updated_at":{"type":"string","format":"date-time"},"workspace_resource_id":{"type":"string","description":"`workspace_resource_id` will only be included in the response if `workspace_resource` is in the list of included associations. See include section for usage."}}}},"components/schemas/WorkspaceStatusChange":{"id":"components/schemas/WorkspaceStatusChange","kind":"json-schema","title":"Workspace Status Change","data":{"title":"Workspace Status Change","description":"Workspace Status Changes represents a record of changes made to the status of a project.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"from_color":{"type":"string","description":"Color of the previous status."},"from_message":{"type":"string","description":"Message of the previous status."},"from_status_key":{"type":"string","description":"Value of the previous status key."},"to_color":{"type":"string","description":"Color of the new status."},"to_message":{"type":"string","description":"Message of the new status."},"to_status_key":{"type":"string","description":"Value of the new status key."},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/WorkspaceStatusSet":{"id":"components/schemas/WorkspaceStatusSet","kind":"json-schema","title":"Workspace Task Status Sets","data":{"title":"Workspace Task Status Sets","description":"Workspace Task Status Sets represent the connection between workspaces (projects) and task (story) status sets, which enable the use of custom task statuses.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"status_set_id":{"type":"integer","format":"int32","description":"The id of the status set that belongs to a project."},"updated_at":{"type":"string","format":"date-time"},"workspace_id":{"type":"integer","format":"int32","description":"The id of the workspace with a status set."}}}},"components/schemas/Workweek":{"id":"components/schemas/Workweek","kind":"json-schema","title":"Workweek","data":{"title":"Workweek","description":"Workweeks are owned by an account. A workweek can be used as the account default, or\ncan be associated to a user through a workweek membership.","type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time a workweek was last updated."},"default":{"type":"boolean","description":"Whether the workweek is the default for the account."},"end_date":{"type":"string","format":"date","description":"The end date of the workweek."},"friday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Friday."},"monday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Monday."},"saturday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Saturday."},"start_date":{"type":"string","format":"date","description":"The start date of the workweek."},"sunday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Sunday."},"thursday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Thursday."},"total_minutes":{"type":"integer","format":"int32","description":"The total number of available working minutes for the week."},"tuesday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Tuesday."},"updated_at":{"type":"string","format":"date-time","description":"The date and time at which a workweek was created."},"wednesday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Wednesday."},"workweek_membership_ids":{"type":"array","items":{"type":"string"},"description":"`workweek_membership_ids` will only be included in the response if `workweek_memberships` is in the list of included associations. See include section for usage."}}}},"components/schemas/WorkweekMembership":{"id":"components/schemas/WorkweekMembership","kind":"json-schema","title":"Workweek Membership","data":{"title":"Workweek Membership","description":"A Workweek Membership represents the relationship of a user to a workweek.","type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time the workweek membership was last updated."},"end_date":{"type":"string","format":"date","description":"The end date of the workweek."},"start_date":{"type":"string","format":"date","description":"The start date of the workweek."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the workweek membership was created."},"user_id":{"type":"integer","format":"int32","description":"The ID of the associated user."},"workweek_id":{"type":"string","description":"`workweek_id` will only be included in the response if `workweek` is in the list of included associations. See include section for usage."}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/Errors":{"id":"components/schemas/Errors","kind":"json-schema","title":"Errors","data":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"components/schemas/ActsAsTaggableOn_Tag":{"id":"components/schemas/ActsAsTaggableOn_Tag","kind":"json-schema","title":"Acts As Taggable On/Tag","data":{"title":"Acts As Taggable On/Tag","type":"object","properties":{"name":{"type":"string"},"status":{"type":"string"}}}},"components/schemas/Attachments_Base":{"id":"components/schemas/Attachments_Base","kind":"json-schema","title":"Attachment","data":{"title":"Attachment","description":"Attachments are files that accompany other resources provided by the Kantata OX API. Expenses can have an\nattachment (tracked as a receipt). Posts can also have attachments, which are displayed along with the post\nin the activity feed or in task tracker.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"creator_name":{"type":"string","description":"The user who originally uploaded the attachment.\nVisible when the attachment belongs to a post."},"deletable":{"type":"boolean","description":"Whether the current user can delete the attachment.\nVisible when the attachment belongs to a post."},"deleted_at":{"type":"string","format":"date-time"},"filename":{"type":"string","description":"The original filename of the attachment when it was uploaded."},"filesize":{"type":"integer","format":"int32","description":"The size of the attachment, in bytes."},"previewable":{"type":"boolean","description":"Whether the attachment is a previewable thumbnailed image."},"updated_at":{"type":"string","format":"date-time"},"url":{"type":"string","description":"The url from which to download the attachment from the CDN."},"view_in_new_tab":{"type":"boolean","description":"Whether the attachment is a filetype that should be viewed in a new tab; usually PDFs."}}}},"components/schemas/Attachments_PostAttachment":{"id":"components/schemas/Attachments_PostAttachment","kind":"json-schema","title":"Attachment","data":{"title":"Attachment","description":"Attachments are files that accompany other resources provided by the Kantata OX API. Expenses can have an\nattachment (tracked as a receipt). Posts can also have attachments, which are displayed along with the post\nin the activity feed or in task tracker.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"creator_name":{"type":"string","description":"The user who originally uploaded the attachment.\nVisible when the attachment belongs to a post."},"deletable":{"type":"boolean","description":"Whether the current user can delete the attachment.\nVisible when the attachment belongs to a post."},"deleted_at":{"type":"string","format":"date-time"},"filename":{"type":"string","description":"The original filename of the attachment when it was uploaded."},"filesize":{"type":"integer","format":"int32","description":"The size of the attachment, in bytes."},"previewable":{"type":"boolean","description":"Whether the attachment is a previewable thumbnailed image."},"updated_at":{"type":"string","format":"date-time"},"url":{"type":"string","description":"The url from which to download the attachment from the CDN."},"view_in_new_tab":{"type":"boolean","description":"Whether the attachment is a filetype that should be viewed in a new tab; usually PDFs."}}}},"components/schemas/Attachments_ProofAttachment":{"id":"components/schemas/Attachments_ProofAttachment","kind":"json-schema","title":"Attachment","data":{"title":"Attachment","description":"Attachments are files that accompany other resources provided by the Kantata OX API. Expenses can have an\nattachment (tracked as a receipt). Posts can also have attachments, which are displayed along with the post\nin the activity feed or in task tracker.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"creator_name":{"type":"string","description":"The user who originally uploaded the attachment.\nVisible when the attachment belongs to a post."},"deletable":{"type":"boolean","description":"Whether the current user can delete the attachment.\nVisible when the attachment belongs to a post."},"deleted_at":{"type":"string","format":"date-time"},"filename":{"type":"string","description":"The original filename of the attachment when it was uploaded."},"filesize":{"type":"integer","format":"int32","description":"The size of the attachment, in bytes."},"previewable":{"type":"boolean","description":"Whether the attachment is a previewable thumbnailed image."},"updated_at":{"type":"string","format":"date-time"},"url":{"type":"string","description":"The url from which to download the attachment from the CDN."},"view_in_new_tab":{"type":"boolean","description":"Whether the attachment is a filetype that should be viewed in a new tab; usually PDFs."}}}},"components/schemas/Attachments_ReceiptAttachment":{"id":"components/schemas/Attachments_ReceiptAttachment","kind":"json-schema","title":"Attachment","data":{"title":"Attachment","description":"Attachments are files that accompany other resources provided by the Kantata OX API. Expenses can have an\nattachment (tracked as a receipt). Posts can also have attachments, which are displayed along with the post\nin the activity feed or in task tracker.","type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"creator_name":{"type":"string","description":"The user who originally uploaded the attachment.\nVisible when the attachment belongs to a post."},"deletable":{"type":"boolean","description":"Whether the current user can delete the attachment.\nVisible when the attachment belongs to a post."},"deleted_at":{"type":"string","format":"date-time"},"filename":{"type":"string","description":"The original filename of the attachment when it was uploaded."},"filesize":{"type":"integer","format":"int32","description":"The size of the attachment, in bytes."},"previewable":{"type":"boolean","description":"Whether the attachment is a previewable thumbnailed image."},"updated_at":{"type":"string","format":"date-time"},"url":{"type":"string","description":"The url from which to download the attachment from the CDN."},"view_in_new_tab":{"type":"boolean","description":"Whether the attachment is a filetype that should be viewed in a new tab; usually PDFs."}}}},"components/schemas/CustomFields_ChoiceField":{"id":"components/schemas/CustomFields_ChoiceField","kind":"json-schema","title":"Custom Field","data":{"title":"Custom Field","description":"The [Custom Fields](https://mavenlink.zendesk.com/hc/en-us/articles/202924760-Custom-Fields-Overview-#arrange) object allows you to\nview, create, update, and delete extra fields for additional Estimate, Project, Group, Resource, Task, and User information.\nIf Custom Fields represent the fields themselves, [Custom Field Values](/tag/Custom-Field-Values)\nrepresent the values in/of those fields.","type":"object","properties":{"choice_ids":{"type":"array","items":{"type":"string"},"description":"`choice_ids` will only be included in the response if `choices` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time"},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"custom_field_set_id":{"type":"string","description":"`custom_field_set_id` will only be included in the response if `custom_field_set` is in the list of included associations. See include section for usage."},"default_text":{"type":"string","description":"The message in an empty custom field, before a `string`, `date`, `number`, or `currency` value is entered in.\nThis only appears in the UI.\nVisible when whether the custom field is an input field.."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"name":{"type":"string","description":"The name of the custom field."},"read_access":{"type":"integer","format":"int32","description":"The `read_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to view a custom field and its value.\n* `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific objects,\nso their minimum permissions are set at the [project level](https://mavenlink.zendesk.com/hc/en-us/articles/115002779293-Project-Permissions):\n - `project_collaboration` (default)\n - `time_logging`\n - `financial`\n - `project_admin`\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators\nare able to view all Project, Resource, and Task custom fields and values across the account,\nregardless of project participation or `read_access` settings.\n* `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide objects,\nso their minimum permissions are set at the [account level](https://mavenlink.zendesk.com/hc/en-us/articles/203041364):\n - `account_collaboration`\n - `project_creator`\n - `project_lead`\n - `reports_viewer`\n - `reports_viewer_with_cost`\n - `account_admin` (default)."},"unique_constraint":{"type":"boolean","description":"Indicates whether a custom field value must be unique across Estimates, Projects, Groups, Resources, Tasks, or Users.\nThis is set to `false` by default.\n\nDoes not apply to Custom Fields with choices.\nVisible when whether the custom field is an input field.."},"updated_at":{"type":"string","format":"date-time"},"value_type":{"type":"string","description":"The format of the [custom field's value](/tag/Custom-Field-Values):\n | Value Type | Format | Sample |\n | -------------------- |:----------------------------------------:| --------------:|\n | `string` | `` | `\"foo\"` |\n | `date` | `` | `\"2014-02-25\"` |\n | `number` | `` | `13` |\n | `currency` | `[, ]`| `[998, \"USD\"]` |\n | `single` and `multi` | `[]` | `[1, 2, 4]` |\n\nThis is set to `string`, by default."},"write_access":{"type":"integer","format":"int32","description":"The permission level required for a user to create, update, or delete a custom field's value."}}}},"components/schemas/CustomFields_ChoiceValue":{"id":"components/schemas/CustomFields_ChoiceValue","kind":"json-schema","title":"Custom Field Value","data":{"title":"Custom Field Value","description":"If [Custom Fields](/tag/Custom-Fields) represent the fields themselves,\nCustom Field Values represent the values in/of those fields.","type":"object","properties":{"account_id":{"type":"integer","format":"int32","description":"The ID of the account the Custom Field Value is in."},"can_edit":{"type":"boolean","description":"Whether the Custom Field Value can be edited by the requester."},"created_at":{"type":"string","format":"date-time"},"custom_field_id":{"type":"string","description":"`custom_field_id` will only be included in the response if `custom_field` is in the list of included associations. See include section for usage."},"custom_field_name":{"type":"string","description":"The name of the Custom Field."},"display_value":{"type":"string","description":"The Custom Field Values, but in more understandable formats:\n* For Custom Fields with values that are selected choices, the labels on those choices are returned.\n* For Custom Fields with currency values, the amount with the currency symbol ($100) is returned.\n* All other values are converted into a string."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"selected_choice_ids":{"type":"array","items":{"type":"string"},"description":"`selected_choice_ids` will only be included in the response if `selected_choices` is in the list of included associations. See include section for usage."},"setter_id":{"type":"string","description":"`setter_id` will only be included in the response if `setter` is in the list of included associations. See include section for usage."},"subject_id":{"type":"integer","format":"int32","description":"The ID of the Estimate, Project, Group, Resource, Task, or User the custom field is for."},"subject_ref":{"type":"object","description":"`subject_ref` will only be included in the response if `subject` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"subject_type":{"type":"string","description":"The set of Custom Fields that values are returned for:\n* `Estimate`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`\n* `Story` (Task)\n* `User`."},"type":{"type":"string","description":"Potential formats of values:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |."},"updated_at":{"type":"string","format":"date-time"},"value":{"type":"string","description":"The value created or updated for the specified custom field.\n\nValues can be created or updated in these formats:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |\n\n##### Note:\nThe `read_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to view a custom field and its value.\n* `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific objects,\nso their minimum permissions are set at the [project level](https://mavenlink.zendesk.com/hc/en-us/articles/115002779293-Project-Permissions):\n- `project_collaboration` (default)\n- `time_logging`\n- `financial`\n- `project_admin`\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators\nare able to view all Project, Resource, and Task custom fields and values across the account,\nregardless of project participation or `read_access` settings.\n* `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide objects,\nso their minimum permissions are set at the [account level](https://mavenlink.zendesk.com/hc/en-us/articles/203041364):\n- `account_collaboration`\n- `project_creator`\n- `project_lead`\n- `reports_viewer`\n- `reports_viewer_with_cost`\n- `account_admin` (default)."}}}},"components/schemas/CustomFields_CurrencyValue":{"id":"components/schemas/CustomFields_CurrencyValue","kind":"json-schema","title":"Custom Field Value","data":{"title":"Custom Field Value","description":"If [Custom Fields](/tag/Custom-Fields) represent the fields themselves,\nCustom Field Values represent the values in/of those fields.","type":"object","properties":{"account_id":{"type":"integer","format":"int32","description":"The ID of the account the Custom Field Value is in."},"can_edit":{"type":"boolean","description":"Whether the Custom Field Value can be edited by the requester."},"created_at":{"type":"string","format":"date-time"},"custom_field_id":{"type":"string","description":"`custom_field_id` will only be included in the response if `custom_field` is in the list of included associations. See include section for usage."},"custom_field_name":{"type":"string","description":"The name of the Custom Field."},"display_value":{"type":"string","description":"The Custom Field Values, but in more understandable formats:\n* For Custom Fields with values that are selected choices, the labels on those choices are returned.\n* For Custom Fields with currency values, the amount with the currency symbol ($100) is returned.\n* All other values are converted into a string."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"selected_choice_ids":{"type":"array","items":{"type":"string"},"description":"`selected_choice_ids` will only be included in the response if `selected_choices` is in the list of included associations. See include section for usage."},"setter_id":{"type":"string","description":"`setter_id` will only be included in the response if `setter` is in the list of included associations. See include section for usage."},"subject_id":{"type":"integer","format":"int32","description":"The ID of the Estimate, Project, Group, Resource, Task, or User the custom field is for."},"subject_ref":{"type":"object","description":"`subject_ref` will only be included in the response if `subject` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"subject_type":{"type":"string","description":"The set of Custom Fields that values are returned for:\n* `Estimate`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`\n* `Story` (Task)\n* `User`."},"type":{"type":"string","description":"Potential formats of values:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |."},"updated_at":{"type":"string","format":"date-time"},"value":{"type":"string","description":"The value created or updated for the specified custom field.\n\nValues can be created or updated in these formats:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |\n\n##### Note:\nThe `read_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to view a custom field and its value.\n* `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific objects,\nso their minimum permissions are set at the [project level](https://mavenlink.zendesk.com/hc/en-us/articles/115002779293-Project-Permissions):\n- `project_collaboration` (default)\n- `time_logging`\n- `financial`\n- `project_admin`\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators\nare able to view all Project, Resource, and Task custom fields and values across the account,\nregardless of project participation or `read_access` settings.\n* `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide objects,\nso their minimum permissions are set at the [account level](https://mavenlink.zendesk.com/hc/en-us/articles/203041364):\n- `account_collaboration`\n- `project_creator`\n- `project_lead`\n- `reports_viewer`\n- `reports_viewer_with_cost`\n- `account_admin` (default)."}}}},"components/schemas/CustomFields_DateValue":{"id":"components/schemas/CustomFields_DateValue","kind":"json-schema","title":"Custom Field Value","data":{"title":"Custom Field Value","description":"If [Custom Fields](/tag/Custom-Fields) represent the fields themselves,\nCustom Field Values represent the values in/of those fields.","type":"object","properties":{"account_id":{"type":"integer","format":"int32","description":"The ID of the account the Custom Field Value is in."},"can_edit":{"type":"boolean","description":"Whether the Custom Field Value can be edited by the requester."},"created_at":{"type":"string","format":"date-time"},"custom_field_id":{"type":"string","description":"`custom_field_id` will only be included in the response if `custom_field` is in the list of included associations. See include section for usage."},"custom_field_name":{"type":"string","description":"The name of the Custom Field."},"display_value":{"type":"string","description":"The Custom Field Values, but in more understandable formats:\n* For Custom Fields with values that are selected choices, the labels on those choices are returned.\n* For Custom Fields with currency values, the amount with the currency symbol ($100) is returned.\n* All other values are converted into a string."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"selected_choice_ids":{"type":"array","items":{"type":"string"},"description":"`selected_choice_ids` will only be included in the response if `selected_choices` is in the list of included associations. See include section for usage."},"setter_id":{"type":"string","description":"`setter_id` will only be included in the response if `setter` is in the list of included associations. See include section for usage."},"subject_id":{"type":"integer","format":"int32","description":"The ID of the Estimate, Project, Group, Resource, Task, or User the custom field is for."},"subject_ref":{"type":"object","description":"`subject_ref` will only be included in the response if `subject` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"subject_type":{"type":"string","description":"The set of Custom Fields that values are returned for:\n* `Estimate`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`\n* `Story` (Task)\n* `User`."},"type":{"type":"string","description":"Potential formats of values:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |."},"updated_at":{"type":"string","format":"date-time"},"value":{"type":"string","description":"The value created or updated for the specified custom field.\n\nValues can be created or updated in these formats:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |\n\n##### Note:\nThe `read_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to view a custom field and its value.\n* `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific objects,\nso their minimum permissions are set at the [project level](https://mavenlink.zendesk.com/hc/en-us/articles/115002779293-Project-Permissions):\n- `project_collaboration` (default)\n- `time_logging`\n- `financial`\n- `project_admin`\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators\nare able to view all Project, Resource, and Task custom fields and values across the account,\nregardless of project participation or `read_access` settings.\n* `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide objects,\nso their minimum permissions are set at the [account level](https://mavenlink.zendesk.com/hc/en-us/articles/203041364):\n- `account_collaboration`\n- `project_creator`\n- `project_lead`\n- `reports_viewer`\n- `reports_viewer_with_cost`\n- `account_admin` (default)."}}}},"components/schemas/CustomFields_InputField":{"id":"components/schemas/CustomFields_InputField","kind":"json-schema","title":"Custom Field","data":{"title":"Custom Field","description":"The [Custom Fields](https://mavenlink.zendesk.com/hc/en-us/articles/202924760-Custom-Fields-Overview-#arrange) object allows you to\nview, create, update, and delete extra fields for additional Estimate, Project, Group, Resource, Task, and User information.\nIf Custom Fields represent the fields themselves, [Custom Field Values](/tag/Custom-Field-Values)\nrepresent the values in/of those fields.","type":"object","properties":{"choice_ids":{"type":"array","items":{"type":"string"},"description":"`choice_ids` will only be included in the response if `choices` is in the list of included associations. See include section for usage."},"created_at":{"type":"string","format":"date-time"},"creator_id":{"type":"string","description":"`creator_id` will only be included in the response if `creator` is in the list of included associations. See include section for usage."},"custom_field_set_id":{"type":"string","description":"`custom_field_set_id` will only be included in the response if `custom_field_set` is in the list of included associations. See include section for usage."},"default_text":{"type":"string","description":"The message in an empty custom field, before a `string`, `date`, `number`, or `currency` value is entered in.\nThis only appears in the UI.\nVisible when whether the custom field is an input field.."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"name":{"type":"string","description":"The name of the custom field."},"read_access":{"type":"integer","format":"int32","description":"The `read_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to view a custom field and its value.\n* `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific objects,\nso their minimum permissions are set at the [project level](https://mavenlink.zendesk.com/hc/en-us/articles/115002779293-Project-Permissions):\n - `project_collaboration` (default)\n - `time_logging`\n - `financial`\n - `project_admin`\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators\nare able to view all Project, Resource, and Task custom fields and values across the account,\nregardless of project participation or `read_access` settings.\n* `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide objects,\nso their minimum permissions are set at the [account level](https://mavenlink.zendesk.com/hc/en-us/articles/203041364):\n - `account_collaboration`\n - `project_creator`\n - `project_lead`\n - `reports_viewer`\n - `reports_viewer_with_cost`\n - `account_admin` (default)."},"unique_constraint":{"type":"boolean","description":"Indicates whether a custom field value must be unique across Estimates, Projects, Groups, Resources, Tasks, or Users.\nThis is set to `false` by default.\n\nDoes not apply to Custom Fields with choices.\nVisible when whether the custom field is an input field.."},"updated_at":{"type":"string","format":"date-time"},"value_type":{"type":"string","description":"The format of the [custom field's value](/tag/Custom-Field-Values):\n | Value Type | Format | Sample |\n | -------------------- |:----------------------------------------:| --------------:|\n | `string` | `` | `\"foo\"` |\n | `date` | `` | `\"2014-02-25\"` |\n | `number` | `` | `13` |\n | `currency` | `[, ]`| `[998, \"USD\"]` |\n | `single` and `multi` | `[]` | `[1, 2, 4]` |\n\nThis is set to `string`, by default."},"write_access":{"type":"integer","format":"int32","description":"The permission level required for a user to create, update, or delete a custom field's value."}}}},"components/schemas/CustomFields_IntegerValue":{"id":"components/schemas/CustomFields_IntegerValue","kind":"json-schema","title":"Custom Field Value","data":{"title":"Custom Field Value","description":"If [Custom Fields](/tag/Custom-Fields) represent the fields themselves,\nCustom Field Values represent the values in/of those fields.","type":"object","properties":{"account_id":{"type":"integer","format":"int32","description":"The ID of the account the Custom Field Value is in."},"can_edit":{"type":"boolean","description":"Whether the Custom Field Value can be edited by the requester."},"created_at":{"type":"string","format":"date-time"},"custom_field_id":{"type":"string","description":"`custom_field_id` will only be included in the response if `custom_field` is in the list of included associations. See include section for usage."},"custom_field_name":{"type":"string","description":"The name of the Custom Field."},"display_value":{"type":"string","description":"The Custom Field Values, but in more understandable formats:\n* For Custom Fields with values that are selected choices, the labels on those choices are returned.\n* For Custom Fields with currency values, the amount with the currency symbol ($100) is returned.\n* All other values are converted into a string."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"selected_choice_ids":{"type":"array","items":{"type":"string"},"description":"`selected_choice_ids` will only be included in the response if `selected_choices` is in the list of included associations. See include section for usage."},"setter_id":{"type":"string","description":"`setter_id` will only be included in the response if `setter` is in the list of included associations. See include section for usage."},"subject_id":{"type":"integer","format":"int32","description":"The ID of the Estimate, Project, Group, Resource, Task, or User the custom field is for."},"subject_ref":{"type":"object","description":"`subject_ref` will only be included in the response if `subject` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"subject_type":{"type":"string","description":"The set of Custom Fields that values are returned for:\n* `Estimate`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`\n* `Story` (Task)\n* `User`."},"type":{"type":"string","description":"Potential formats of values:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |."},"updated_at":{"type":"string","format":"date-time"},"value":{"type":"string","description":"The value created or updated for the specified custom field.\n\nValues can be created or updated in these formats:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |\n\n##### Note:\nThe `read_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to view a custom field and its value.\n* `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific objects,\nso their minimum permissions are set at the [project level](https://mavenlink.zendesk.com/hc/en-us/articles/115002779293-Project-Permissions):\n- `project_collaboration` (default)\n- `time_logging`\n- `financial`\n- `project_admin`\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators\nare able to view all Project, Resource, and Task custom fields and values across the account,\nregardless of project participation or `read_access` settings.\n* `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide objects,\nso their minimum permissions are set at the [account level](https://mavenlink.zendesk.com/hc/en-us/articles/203041364):\n- `account_collaboration`\n- `project_creator`\n- `project_lead`\n- `reports_viewer`\n- `reports_viewer_with_cost`\n- `account_admin` (default)."}}}},"components/schemas/CustomFields_StringValue":{"id":"components/schemas/CustomFields_StringValue","kind":"json-schema","title":"Custom Field Value","data":{"title":"Custom Field Value","description":"If [Custom Fields](/tag/Custom-Fields) represent the fields themselves,\nCustom Field Values represent the values in/of those fields.","type":"object","properties":{"account_id":{"type":"integer","format":"int32","description":"The ID of the account the Custom Field Value is in."},"can_edit":{"type":"boolean","description":"Whether the Custom Field Value can be edited by the requester."},"created_at":{"type":"string","format":"date-time"},"custom_field_id":{"type":"string","description":"`custom_field_id` will only be included in the response if `custom_field` is in the list of included associations. See include section for usage."},"custom_field_name":{"type":"string","description":"The name of the Custom Field."},"display_value":{"type":"string","description":"The Custom Field Values, but in more understandable formats:\n* For Custom Fields with values that are selected choices, the labels on those choices are returned.\n* For Custom Fields with currency values, the amount with the currency symbol ($100) is returned.\n* All other values are converted into a string."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"selected_choice_ids":{"type":"array","items":{"type":"string"},"description":"`selected_choice_ids` will only be included in the response if `selected_choices` is in the list of included associations. See include section for usage."},"setter_id":{"type":"string","description":"`setter_id` will only be included in the response if `setter` is in the list of included associations. See include section for usage."},"subject_id":{"type":"integer","format":"int32","description":"The ID of the Estimate, Project, Group, Resource, Task, or User the custom field is for."},"subject_ref":{"type":"object","description":"`subject_ref` will only be included in the response if `subject` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"subject_type":{"type":"string","description":"The set of Custom Fields that values are returned for:\n* `Estimate`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`\n* `Story` (Task)\n* `User`."},"type":{"type":"string","description":"Potential formats of values:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |."},"updated_at":{"type":"string","format":"date-time"},"value":{"type":"string","description":"The value created or updated for the specified custom field.\n\nValues can be created or updated in these formats:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |\n\n##### Note:\nThe `read_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to view a custom field and its value.\n* `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific objects,\nso their minimum permissions are set at the [project level](https://mavenlink.zendesk.com/hc/en-us/articles/115002779293-Project-Permissions):\n- `project_collaboration` (default)\n- `time_logging`\n- `financial`\n- `project_admin`\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators\nare able to view all Project, Resource, and Task custom fields and values across the account,\nregardless of project participation or `read_access` settings.\n* `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide objects,\nso their minimum permissions are set at the [account level](https://mavenlink.zendesk.com/hc/en-us/articles/203041364):\n- `account_collaboration`\n- `project_creator`\n- `project_lead`\n- `reports_viewer`\n- `reports_viewer_with_cost`\n- `account_admin` (default)."}}}},"components/schemas/Project_Snapshots_Models_ProjectSnapshot":{"id":"components/schemas/Project_Snapshots_Models_ProjectSnapshot","kind":"json-schema","title":"Project Snapshots","data":{"title":"Project Snapshots","description":"Project snapshots capture the state of a project at a specific point in time. Snapshots are useful for gaining a historical perspective on a project, and for comparing the current state of a project to a previous state.\n\nProject financials, tasks, and resources are all captured in a snapshot, as well as project and task custom field values.","type":"object","properties":{"budget_in_cents":{"type":"integer","format":"int32","description":"The budget of the project at the time of the snapshot, in the subunits of the currency (e.g. cents for USD)."},"created_at":{"type":"string","format":"date-time","description":"When the snapshot was created."},"currency":{"type":"string","description":"The [ISO code](https://knowledge.kantata.com/hc/en-us/articles/360041576473) of the currency set on the project at the time of the snapshot."},"description":{"type":"string","description":"The description of the snapshot."},"due_date":{"type":"string","format":"date","description":"The due date of the project at the time of the snapshot."},"duration":{"type":"string","description":"The duration of the project at the time of the snapshot, based on the earliest start date and latest due date of tasks."},"is_baseline":{"type":"boolean","description":"Whether the snapshot is set as the baseline for the project."},"project_snapshot_assignment_ids":{"type":"array","items":{"type":"string"},"description":"`project_snapshot_assignment_ids` will only be included in the response if `project_snapshot_assignments` is in the list of included associations. See include section for usage."},"project_snapshot_custom_field_value_ids":{"type":"array","items":{"type":"string"},"description":"`project_snapshot_custom_field_value_ids` will only be included in the response if `project_snapshot_custom_field_values` is in the list of included associations. See include section for usage."},"project_snapshot_resource_ids":{"type":"array","items":{"type":"string"},"description":"`project_snapshot_resource_ids` will only be included in the response if `project_snapshot_resources` is in the list of included associations. See include section for usage."},"project_snapshot_task_custom_field_value_ids":{"type":"array","items":{"type":"string"},"description":"`project_snapshot_task_custom_field_value_ids` will only be included in the response if `project_snapshot_task_custom_field_values` is in the list of included associations. See include section for usage."},"project_snapshot_task_ids":{"type":"array","items":{"type":"string"},"description":"`project_snapshot_task_ids` will only be included in the response if `project_snapshot_tasks` is in the list of included associations. See include section for usage."},"start_date":{"type":"string","format":"date","description":"The start date of the project at the time of the snapshot."},"status_as_text":{"type":"string","description":"The status of the project at the time of the snapshot."},"status_color":{"type":"string","description":"The status color of the project at the time of the snapshot."},"title":{"type":"string","description":"The title of the snapshot."},"workspace_id":{"type":"string","description":"The ID of the project the snapshot is for."}}}},"components/schemas/Project_Snapshots_Models_ProjectSnapshotAssignment":{"id":"components/schemas/Project_Snapshots_Models_ProjectSnapshotAssignment","kind":"json-schema","title":"Project Snapshot Assignments","data":{"title":"Project Snapshot Assignments","description":"Project snapshot assignments represent the state of task assignments in a project when a snapshot was taken, including resource estimated minutes, scheduled minutes, and rates.","type":"object","properties":{"bill_rate_in_cents":{"type":"integer","format":"int32","description":"The bill rate in cents of the resource at the time of the snapshot."},"cost_rate_in_cents":{"type":"integer","format":"int32","description":"The cost rate in cents of the resource at the time of the snapshot."},"estimated_minutes":{"type":"integer","format":"int32","description":"The estimated time in minutes for the resource of this assignment at the time of the snapshot."},"project_snapshot_resource_id":{"type":"integer","format":"int32","description":"The ID of the resource the assignment is for."},"project_snapshot_task_id":{"type":"integer","format":"int32","description":"The ID of the task the assignment is for."},"scheduled_minutes":{"type":"integer","format":"int32","description":"The scheduled minutes of the assignment."}}}},"components/schemas/Project_Snapshots_Models_ProjectSnapshotCustomFieldValue":{"id":"components/schemas/Project_Snapshots_Models_ProjectSnapshotCustomFieldValue","kind":"json-schema","title":"Snapshot Custom Field Value","data":{"title":"Snapshot Custom Field Value","description":"Snapshot custom field values represent the state of project and task custom field values when a snapshot was taken.","type":"object","properties":{"custom_field_name":{"type":"string","description":"The name of the custom field."},"subject_id":{"type":"integer","format":"int32","description":"The ID of the snapshot project or snapshot task the custom field value is for. This is not the same as the project or task ID."},"subject_type":{"type":"string","description":"The subject type of the custom field value, e.g. `SnapshotWorkspace` (snapshot project) or `SnapshotStory` (snapshot task)."},"value":{"type":"string","description":"The value of the custom field."},"value_type":{"type":"string","description":"The value type of the custom field, e.g. `string`, `date`, `number`, `currency`, `single`, or `multi`."}}}},"components/schemas/Project_Snapshots_Models_ProjectSnapshotResource":{"id":"components/schemas/Project_Snapshots_Models_ProjectSnapshotResource","kind":"json-schema","title":"Project Snapshot Resources","data":{"title":"Project Snapshot Resources","description":"Project Snapshot Resources represent the state of project resources when a snapshot was taken, including their roles and total project allocation.","type":"object","properties":{"allocated_minutes":{"type":"integer","format":"int32","description":"The number of minutes the resource was allocated on the project at the time of the snapshot."},"name":{"type":"string","description":"For named resources, this is the person's full name. For unnamed resources, this is the title."},"project_snapshot_id":{"type":"integer","format":"int32","description":"The ID of the snapshot this snapshot resource is for."},"resource_id":{"type":"integer","format":"int32","description":"The ID of the resource."},"role_id":{"type":"integer","format":"int32","description":"The ID of the role the resource had on the project at the time of the snapshot."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user for the resource at the time of the snapshot. For unnamed resources, this is null."}}}},"components/schemas/Project_Snapshots_Models_ProjectSnapshotTask":{"id":"components/schemas/Project_Snapshots_Models_ProjectSnapshotTask","kind":"json-schema","title":"Project Snapshot Task","data":{"title":"Project Snapshot Task","description":"Project snapshot tasks represent the state of tasks in a project when a snapshot was taken.","type":"object","properties":{"archived":{"type":"boolean","description":"Whether the task was archived when the snapshot was taken."},"billable":{"type":"boolean","description":"Whether the task was billable when the snapshot was taken."},"budget_estimate_in_cents":{"type":"integer","format":"int32","description":"The budget of the task when the snapshot was taken."},"description":{"type":"string","description":"The description of the task when the snapshot was taken."},"due_date":{"type":"string","description":"The due date of the task when the snapshot was taken."},"percentage_complete":{"type":"integer","format":"int32","description":"The percentage complete of the task when the snapshot was taken."},"priority_level":{"type":"integer","format":"int32","description":"The priority level of the task when the snapshot was taken."},"project_plan":{"type":"boolean","description":"Whether the task was a project task (`true`) or a To Do (`false`) when the snapshot was taken."},"project_snapshot_id":{"type":"integer","format":"int32","description":"The ID of the snapshot this snapshot task is for."},"start_date":{"type":"string","description":"The start date of the task when the snapshot was taken."},"state":{"type":"string","description":"The status of the task when the snapshot was taken."},"story_id":{"type":"integer","format":"int32","description":"The ID of the story (task)."},"story_type":{"type":"string","description":"The type of the task when the snapshot was taken."},"time_estimate_in_minutes":{"type":"integer","format":"int32","description":"The task estimate in minutes when the snapshot was taken."},"title":{"type":"string","description":"The title of the task when the snapshot was taken."},"wbs":{"type":"integer","format":"int32","description":"The WBS number of the task when the snapshot was taken."}}}},"components/schemas/ProjectAccounting_Models_ProjectAccountingRecord":{"id":"components/schemas/ProjectAccounting_Models_ProjectAccountingRecord","kind":"json-schema","title":"Project Accounting Records","data":{"title":"Project Accounting Records","description":"Project accounting records.","type":"object","properties":{"account_id":{"type":"integer","format":"int32","description":"The ID of the account this record belongs to."},"amount":{"type":"number","format":"float","description":"The amount calculated for baseline, forecasting,\n earned value, earned value forecasting, or revenue recognition\n within the specified accounting period."},"amount_to_date":{"type":"number","format":"float","description":"The total amount spent to date (for all accounting periods)."},"budget":{"type":"number","format":"float","description":"The budget of the project or task."},"calculated_revenue_amount":{"type":"number","format":"float","description":"The calculated revenue amount for this accounting period."},"contract_date":{"type":"string","format":"date","description":"A contract's start or end date, or any other designated date."},"cost":{"type":"number","format":"float","description":"The cost of the project or task within the specified accounting period."},"cost_eac":{"type":"number","format":"float","description":"The [estimated cost](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n of the project or task when it is completed. This updates during the course of a project or task, as costs are logged."},"cost_to_date":{"type":"number","format":"float","description":"The total cost accumulated to date for this accounting period."},"created_at":{"type":"string","format":"date","description":"The date the record was created."},"currency":{"type":"string","description":"The currency of the record. See the\n [ISO codes of currencies supported by Kantata OX](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473)."},"description":{"type":"string","description":"A brief description of the record."},"end_date":{"type":"string","format":"date","description":"The date the accounting period ends."},"external_reference_ids":{"type":"array","items":{"type":"string"},"description":"`external_reference_ids` will only be included in the response if `external_references` is in the list of included associations. See include section for usage."},"fees":{"type":"number","format":"float","description":"The fees from the specified accounting period."},"forecast":{"type":"number","format":"float","description":"The forecast value for this accounting period."},"forecast_locked":{"type":"boolean","description":"Whether the forecast amount has been verified and locked, which happens when the previous period is closed.\n If `true`, the forecast amount will not update if forecasted hours or expense budgets are added to the period."},"has_revenue_override":{"type":"boolean","description":"Whether this record has a revenue override applied."},"hours":{"type":"number","format":"float","description":"The [hours](https://mavenlink.zendesk.com/hc/en-us/articles/360059325413)\n spent within the specified accounting period."},"hours_eac":{"type":"number","format":"float","description":"The [estimated hours](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n for the project or task when it is completed. This updates during the course of a project or task, as hours are logged."},"hours_etc":{"type":"number","format":"float","description":"The [estimated hours](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n until completion (`hours_eac` - `hours`) of the project or task."},"labor_type":{"type":"string","description":"Whether the cost associated with the record is for `Labor` or `Non-Labor`."},"notes":{"type":"string","description":"Extra information to note about the record."},"percent_complete":{"type":"number","format":"float","description":"How much of the project or task is complete in decimal format (e.g. 0.75 = 75%)."},"remaining_forecast":{"type":"number","format":"float","description":"The remaining forecast amount for an Open period. If the period is not Open, this is `null`.\nThis field may only have a value when the\n[early access feature Revenue Management](https://knowledge.kantata.com/hc/en-us/articles/38986877019803-Revenue-Management-Early-Access)\nis activated on the account."},"revenue_method":{"type":"string","description":"The name of the revenue recognition method from the project accounting record."},"revenue_override_notes":{"type":"string","description":"A user-entered note added when manually overriding the calculated revenue value on a project accounting record.\nThis field may only have a value when the\n[early access feature Revenue Management](https://knowledge.kantata.com/hc/en-us/articles/38986877019803-Revenue-Management-Early-Access)\nis activated on the account."},"role_id":{"type":"string","description":"`role_id` will only be included in the response if `role` is in the list of included associations. See include section for usage."},"service_type":{"type":"string","description":"An organization-specific category of services\n that is related to the record (e.g. Branding, Campaigns, Photography, etc.)."},"start_date":{"type":"string","format":"date","description":"The date the accounting period begins."},"status":{"type":"string","description":"The status of the record (`Unsubmitted`, `Draft`, `Pending Approval`, `Approved`, `Cancelled`, `Reopened`, or `Adjusted`)."},"story_id":{"type":"string","description":"`story_id` will only be included in the response if `story` is in the list of included associations. See include section for usage."},"system_generated":{"type":"boolean","description":"Whether this record was generated by the system as part of Kantata's revenue recognition process."},"total_estimated_hours":{"type":"number","format":"float","description":"The hours initially estimated for the project or task.\n This value does not change over the course of a project."},"total_hours_to_date":{"type":"number","format":"float","description":"The total hours logged to date for the project or task."},"type":{"type":"string","description":"The type of project accounting record (`Baseline`, `Earned Value`,\n `Earned Value Forecasting`, `Forecasting`, or `Recognition`)."},"user_id":{"type":"string","description":"`user_id` will only be included in the response if `user` is in the list of included associations. See include section for usage."},"workspace_id":{"type":"string","description":"`workspace_id` will only be included in the response if `workspace` is in the list of included associations. See include section for usage."}}}},"components/schemas/SubscribedEvents_Models_SubscribedEvent":{"id":"components/schemas/SubscribedEvents_Models_SubscribedEvent","kind":"json-schema","title":"Subscribed Event","data":{"title":"Subscribed Event","description":"An API feature that returns the last 9 days of trackable changes (\"events\") in an account.\n\nFor a list of all the event types tracked by Subscribed Events, please see the [Knowledge Base](https://knowledge.kantata.com/hc/en-us/articles/4407962435227-Subscribed-Events-Reference).","type":"object","properties":{"account_id":{"type":"integer","format":"int32","description":"The ID of the account that the change occurred in."},"context_workspace_id":{"type":"string","description":"The ID of the workspace associated with the event, if any."},"created_at":{"type":"string","format":"date-time","description":"The date and time the event record was created. Note that this is not when the action was actually performed and may be different from `subject_changed_at`."},"current_payload":{"type":"string","description":"The updated data record, as metadata in JSON format.\nOnly returned when requested through the optional_fields param."},"event_type":{"type":"string","description":"The type of change event. For a list of all the event types tracked by Subscribed Events, please see the [Knowledge Base](https://knowledge.kantata.com/hc/en-us/articles/4407962435227-Subscribed-Events-Reference)."},"payload_changes":{"type":"string","description":"The previous and current values for the changed fields in the data record, as metadata in JSON format.\nOnly returned when requested through the optional_fields param."},"previous_payload":{"type":"string","description":"The data record before it was changed, as metadata in JSON format.\nOnly returned when requested through the optional_fields param."},"subject_changed_at":{"type":"string","format":"date-time","description":"The date and time the event was triggered (i.e. when the action was performed)."},"subject_id":{"type":"integer","format":"int32","description":"The ID of the data record that was changed."},"subject_ref":{"type":"object","description":"`subject_ref` will only be included in the response if `subject` is in the list of included associations. See include section for usage.","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"subject_type":{"type":"string","description":"The type of data record that was changed (e.g. TimeEntry)."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user who made the change."}}}},"schema_302":{"kind":"json-schema","data":{"type":"object","properties":{"subscribed_event_types":{"type":"array","items":{"type":"string"},"description":"A complete list of Subscribed Event Types."},"subscribed_event_type_schemas":{"type":"object","additionalProperties":{"type":"object","description":"Provides a reference of all event types and the properties that the Subscribed Events\nendpoint returns for each event type in the payload fields (`previous_payload`, `current_payload`,\nand `payload_changes`).","properties":{"name":{"type":"string","description":"The name of the event type."},"description":{"type":"string","description":"The description of the event type."},"fields":{"type":"object","description":"The properties that the Subscribed Events endpoint returns in the payload fields\n(`previous_payload`, `current_payload`, and `payload_changes`) for an event type.","additionalProperties":{"type":"object","description":"The attribute key for the property.","properties":{"name":{"type":"string","description":"The name of the property."},"type":{"type":"string","description":"The data type of the property value."},"description":{"type":"string","description":"The description of the property."},"fields":{"type":"object","description":"Nested attributes of the property if any.","properties":{"name":{"type":"string","description":"The name of the nested property."},"type":{"type":"string","description":"The data type of the nested property value."},"description":{"type":"string","description":"The description of the nested property."}}}}}}}}}}},"id":"schema_302"},"schema_303":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_303"},"schema_304":{"kind":"json-schema","data":{"type":"string"},"id":"schema_304"},"schema_305":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["previous_payload","current_payload","payload_changes"]}},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"type":"string","default":"created_at:desc"},"id":"schema_307"},"schema_308":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":1},"id":"schema_308"},"schema_309":{"kind":"json-schema","data":{"type":"integer","format":"int32","maximum":200,"default":20},"id":"schema_309"},"schema_310":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"subscribed_events":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SubscribedEvents_Models_SubscribedEvent"}},"account_colors":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountColor"}},"account_locations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountLocation"}},"account_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountMembership"}},"assignments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Assignment"}},"billing_milestones":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BillingMilestone"}},"cost_rates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CostRate"}},"custom_fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomField"}},"custom_field_sets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldSet"}},"estimates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Estimate"}},"estimate_scenarios":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EstimateScenario"}},"estimate_scenario_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EstimateScenarioResource"}},"expenses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Expense"}},"expense_budgets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExpenseBudget"}},"expense_report_submissions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExpenseReportSubmission"}},"invoices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Invoice"}},"line_item_locks":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/LineItemLock"}},"organizations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Organization"}},"organization_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/OrganizationMembership"}},"participations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Participation"}},"project_accounting_records":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProjectAccounting_Models_ProjectAccountingRecord"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}},"skills":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Skill"}},"skill_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SkillMembership"}},"task_status_sets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StatusSet"}},"custom_task_statuses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StatusSetOption"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"story_allocation_days":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StoryAllocationDay"}},"time_entries":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TimeEntry"}},"time_off_entries":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TimeOffEntry"}},"timesheet_submissions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TimesheetSubmission"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"vendors":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Vendor"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"workspace_allocations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceAllocation"}},"workspace_groups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceGroup"}},"workspace_invitations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceInvitation"}},"workspace_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceResource"}},"workspace_task_status_sets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceStatusSet"}},"workweeks":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workweek"}},"workweek_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkweekMembership"}}}},"id":"schema_310"},"schema_311":{"kind":"json-schema","data":{"type":"string","default":"exclude"},"id":"schema_311"},"schema_312":{"kind":"json-schema","data":{"type":"string","default":"name"},"id":"schema_312"},"schema_313":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_313"},"schema_314":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"account_locations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountLocation"}}}},"id":"schema_314"},"schema_315":{"kind":"json-schema","data":{"type":"object","properties":{"account_location":{"type":"object","properties":{"name":{"type":"string","description":"The location the Account Location represents."},"archived":{"type":"boolean","description":"Whether the account location is archived or active. Defaults to false."}}}}},"id":"schema_315"},"schema_316":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_316"},"schema_317":{"kind":"json-schema","data":{"type":"object","properties":{"account_location":{"type":"object","properties":{"name":{"type":"string","description":"The location the Account Location represents."},"archived":{"type":"boolean","description":"Whether the account location is archived or active."}}}}},"id":"schema_317"},"schema_318":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"access_group_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccessGroupMembership"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}}}},"id":"schema_318"},"schema_319":{"kind":"json-schema","data":{"type":"object","properties":{"access_group_membership":{"type":"object","properties":{"access_group_id":{"type":"integer","format":"int32","description":"The ID of the access group to add the user to."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user to add to the access group."}},"required":["access_group_id","user_id"]}}},"id":"schema_319"},"schema_320":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"string","description":"Confirmation message describing which membership was deleted."}}},"id":"schema_320"},"schema_321":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_321"},"schema_322":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"account_colors":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountColor"}}}},"id":"schema_322"},"schema_323":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"account_invitations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountInvitation"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}}}},"id":"schema_323"},"schema_324":{"kind":"json-schema","data":{"type":"object","properties":{"account_invitation":{"type":"object","properties":{"billability_target":{"type":"integer","format":"int32"},"bill_rate_in_cents":{"type":"integer","format":"int32","description":"The default billing rate, in cents, for the user in a workspace on this account (when the workspace\ndoes not use a rate card). This attribute can only be set if the current user is either an Administrator\nor a Project Lead on the account."},"cost_rate_in_cents":{"type":"integer","format":"int32","description":"The default cost rate, in cents, for the user in a workspace on this account. This attribute can\nonly be set if the current user is an Administrator on the account."},"default_read_only":{"type":"boolean","description":"The invited user should have read-only permissions."},"default_role_id":{"type":"integer","format":"int32","description":"The internal ID for the default role specified to the invited user."},"email_address":{"type":"string","description":"The email address of the invited user. A link to accept the invitation is sent to this address."},"full_name":{"type":"string","description":"The full name of the invited user."},"headline":{"type":"string"},"permission":{"type":"string","description":"The permission level of the invited user. See account_memberships for more details. Valid values\ninclude administrator, reports_viewer_with_cost, reports_viewer, project_lead, project_creator, collaborator, and punch_clock.\"."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["email_address","full_name"]}}},"id":"schema_324"},"schema_325":{"kind":"json-schema","data":{"type":"object","properties":{"account_invitation":{"type":"object","properties":{"billability_target":{"type":"integer","format":"int32"},"bill_rate_in_cents":{"type":"integer","format":"int32","description":"The default billing rate, in cents, for the user in a workspace on this account (when the workspace\ndoes not use a rate card). This attribute can only be set if the current user is either an Administrator\nor a Project Lead on the account."},"cost_rate_in_cents":{"type":"integer","format":"int32","description":"The default cost rate used, in cents, for the user in a workspace on this account. This attribute can\nonly be set if the current user is an Administrator on the account."},"default_role_id":{"type":"integer","format":"int32","description":"The internal ID for the default role specified to the invited user."},"permission":{"type":"string","description":"The permission level of the invited user. See account_memberships for more details. Valid values\ninclude administrator, reports_viewer_with_cost, reports_viewer, project_lead, project_creator, collaborator, and punch_clock.\"."}}}}},"id":"schema_325"},"schema_326":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["can_log_in","non_participant"]}},"id":"schema_326"},"schema_327":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"account_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountMembership"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}},"workweeks":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workweek"}},"skill_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SkillMembership"}},"backup_approver_associations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BackupApproverAssociation"}},"cost_rates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CostRate"}},"billable_utilizations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BillableUtilization"}}}},"id":"schema_327"},"schema_328":{"kind":"json-schema","data":{"type":"object","properties":{"account_membership":{"type":"object","properties":{"bill_rate_in_cents":{"type":"integer","format":"int32","description":"The default billing rate, in cents, for the user in a workspace on this account."},"cost_rate_in_cents":{"type":"integer","format":"int32","description":"The default cost rate, in cents, for the user in a workspace on this account."},"default_role_id":{"type":"integer","format":"int32","description":"The internal ID for the role of this user on this account."},"permission":{"type":"string","description":"The user's permission level on the account. Valid values are 'administrator', 'reports_viewer', 'reports_viewer_with_cost', 'project_lead', 'project_creator', 'punch_clock', 'external_collaborator' or 'collaborator'."},"billability_target":{"type":"integer","format":"int32","description":"Value for setting the user's billability target."},"default_read_only":{"type":"boolean","description":"Whether the user is always read-only in workspaces."},"manager_id":{"type":"integer","format":"int32","description":"The User ID of the user's manager."},"manager_can_approve":{"type":"boolean","description":"Whether the user's named manager can approve their time and expenses."},"manager_can_edit_skills":{"type":"boolean","description":"Whether the user's named manager can edit their skills."},"should_show_alert_on_timesheet_submission":{"type":"boolean","description":"Show an alert on a user's timesheet."},"change_role_option":{"type":"string","description":"Select 'update_with_new_role', 'add_another_role', or 'keep_existing_role'. If no option is selected another role will be added."},"enforce_workweek_minimum_on_timesheet_submission":{"type":"boolean","description":"If true, the user is required to submit timesheets equal to or greater than their workweek hours."},"enforce_workweek_maximum_on_timesheet_submission":{"type":"boolean","description":"If true, the user is required to submit timesheets equal to or less than their workweek hours."}}}}},"id":"schema_328"},"schema_329":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"backup_approver_associations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BackupApproverAssociation"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}}}},"id":"schema_329"},"schema_330":{"kind":"json-schema","data":{"type":"object","properties":{"backup_approver_association":{"type":"object","properties":{"backup_approver_id":{"type":"integer","format":"int32","description":"The ID of the user designated as backup approver."},"approver_id":{"type":"integer","format":"int32","description":"The ID of the user designated as the approver."},"start_date":{"type":"string","format":"date","description":"The start date on which the approver and backup approver are current. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"end_date":{"type":"string","format":"date","description":"The end date on which the approver and backup approver are current. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}},"required":["backup_approver_id","approver_id","start_date","end_date"]}}},"id":"schema_330"},"schema_331":{"kind":"json-schema","data":{"type":"object","properties":{"backup_approver_association":{"type":"object","properties":{"backup_approver_id":{"type":"integer","format":"int32","description":"The ID of the user designated as backup approver."},"approver_id":{"type":"integer","format":"int32","description":"The ID of the user designated as the approver."},"start_date":{"type":"string","format":"date","description":"The start date on which the approver and backup approver are current. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"end_date":{"type":"string","format":"date","description":"The end date on which the approver and backup approver are current. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}}}}},"id":"schema_331"},"schema_332":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"billable_utilizations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BillableUtilization"}},"account_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountMembership"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}}}},"id":"schema_332"},"schema_333":{"kind":"json-schema","data":{"type":"object","properties":{"billable_utilization":{"type":"object","properties":{"effective_date":{"type":"string","format":"date","description":"The date the billable utilization becomes active. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"target":{"type":"integer","format":"int32","description":"The percentage of logged time that should be billable for the account member."},"account_membership_id":{"type":"integer","format":"int32","description":"The account membership ID of the user to set the billable utilization for."}},"required":["effective_date","target","account_membership_id"]}}},"id":"schema_333"},"schema_334":{"kind":"json-schema","data":{"type":"object","properties":{"billable_utilization":{"type":"object","properties":{"effective_date":{"type":"string","format":"date","description":"The date the billable utilization becomes active. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"target":{"type":"integer","format":"int32","description":"The percentage of logged time that should be billable for the account member."}},"required":["effective_date","target"]}}},"id":"schema_334"},"schema_335":{"kind":"json-schema","data":{"type":"string","default":"created_at:asc"},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"cost_rates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CostRate"}},"account_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountMembership"}}}},"id":"schema_336"},"schema_337":{"kind":"json-schema","data":{"type":"object","properties":{"cost_rate":{"type":"object","properties":{"account_membership_id":{"type":"integer","format":"int32","description":"The ID of the account membership associated to the cost rate."},"currency":{"type":"string","description":"The ISO currency code for the cost rate currency."},"amount_in_subunits":{"type":"integer","format":"int32","description":"The cost amount, in subunits of the currency (for example, cents for US dollars)."}},"required":["account_membership_id","currency","amount_in_subunits"]},"cost_rates":{"type":"array","description":"Multiple cost rates and their attributes in an array.","items":{"type":"object","properties":{"account_membership_id":{"type":"integer","format":"int32","description":"The ID of the account membership associated to the cost rate."},"currency":{"type":"string","description":"The ISO currency code for the cost rate currency."},"amount_in_subunits":{"type":"integer","format":"int32","description":"The cost amount, in subunits of the currency (for example, cents for US dollars)."}},"required":["account_membership_id","currency","amount_in_subunits"]}}}},"id":"schema_337"},"schema_338":{"kind":"json-schema","data":{"type":"object","properties":{"cost_rate":{"type":"object","properties":{"amount_in_subunits":{"type":"integer","format":"int32","description":"The cost amount, in subunits of the currency (for example, cents for US dollars)."}},"required":["amount_in_subunits"]}}},"id":"schema_338"},"schema_339":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"private_label":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PrivateLabel"}}}},"id":"schema_339"},"schema_340":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"organization_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/OrganizationMembership"}},"organizations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Organization"}}}},"id":"schema_340"},"schema_341":{"kind":"json-schema","data":{"type":"object","properties":{"organization_membership":{"type":"object","properties":{"geography_id":{"type":"integer","format":"int32","description":"The ID of the membership's geography."},"department_id":{"type":"integer","format":"int32","description":"The ID of the membership's department."},"member_id":{"type":"integer","format":"int32","description":"The ID of the project or user."},"member_type":{"type":"string","description":"The type of object that describes the member (workspace or user)."}},"required":["geography_id","department_id","member_id","member_type"]}}},"id":"schema_341"},"schema_342":{"kind":"json-schema","data":{"type":"object","properties":{"organization_membership":{"type":"object","properties":{"geography_id":{"type":"integer","format":"int32","description":"The ID of the membership's geography."},"department_id":{"type":"integer","format":"int32","description":"The ID of the membership's department."}}}}},"id":"schema_342"},"schema_343":{"kind":"json-schema","data":{"type":"string","default":"alphabetical:asc"},"id":"schema_343"},"schema_344":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"organizations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Organization"}}}},"id":"schema_344"},"schema_345":{"kind":"json-schema","data":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"The name of the organization."},"parent_id":{"type":"integer","format":"int32","description":"The id of the parent organization."}},"required":["name","parent_id"]}}},"id":"schema_345"},"schema_346":{"kind":"json-schema","data":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"The name of the organization."},"parent_id":{"type":"integer","format":"int32","description":"The id of the parent organization being created."}}}}},"id":"schema_346"},"schema_347":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}}}},"id":"schema_347"},"schema_348":{"kind":"json-schema","data":{"type":"object","properties":{"role":{"type":"object","properties":{"name":{"type":"string","description":"The name of the role being created."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["name"]}}},"id":"schema_348"},"schema_349":{"kind":"json-schema","data":{"type":"object","properties":{"role":{"type":"object","properties":{"name":{"type":"string","description":"The updated name of the existing role."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_349"},"schema_350":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"skill_categories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SkillCategory"}},"skills":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Skill"}}}},"id":"schema_350"},"schema_351":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_351"},"schema_352":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer","format":"int32"}},"id":"schema_352"},"schema_353":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"skill_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SkillMembership"}},"skills":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Skill"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}}}},"id":"schema_353"},"schema_354":{"kind":"json-schema","data":{"type":"object","properties":{"skill_membership":{"type":"object","properties":{"skill_id":{"type":"integer","format":"int32","description":"The ID of the skill."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user."},"level":{"type":"integer","format":"int32","description":"The user's proficiency level in the skill (1-5). This defaults to 0 if it is not specified.\nNote: Not all skills have levels."}},"required":["skill_id","user_id"]}}},"id":"schema_354"},"schema_355":{"kind":"json-schema","data":{"type":"object","properties":{"skill_membership":{"type":"object","properties":{"level":{"type":"integer","format":"int32","description":"The user's proficiency level in the skill (1-5). This defaults to 0 if it is not specified.\nNote: Not all skills have levels."}}}}},"id":"schema_355"},"schema_356":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"skills":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Skill"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"skill_categories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SkillCategory"}}}},"id":"schema_356"},"schema_357":{"kind":"json-schema","data":{"type":"object","properties":{"skill":{"type":"object","properties":{"name":{"type":"string","description":"The name of the skill to be created."},"max_level":{"type":"string","description":"The max number of levels allowed for the skill and must be either 1 or 5."},"skill_category_id":{"type":"integer","format":"int32","description":"The id of the skill category associated with this skill."},"description":{"type":"string","description":"The description of the skill."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["name","max_level","skill_category_id"]}}},"id":"schema_357"},"schema_358":{"kind":"json-schema","data":{"type":"object","properties":{"skill":{"type":"object","properties":{"name":{"type":"string","description":"The name of the skill to be created."},"max_level":{"type":"string","description":"The max number of levels allowed for the skill and must be either 1 or 5."},"skill_category_id":{"type":"integer","format":"int32","description":"The id of the skill category associated with this skill."},"description":{"type":"string","description":"The description of the skill."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_358"},"schema_359":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"task_status_sets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StatusSet"}},"custom_task_statuses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StatusSetOption"}}}},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"type":"object","properties":{"task_status_set":{"type":"object","properties":{"name":{"type":"string","description":"The name of the task status set."}},"required":["name"]}}},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"type":"object","properties":{"custom_task_status":{"type":"object","properties":{"status":{"type":"string","description":"The name of the custom task status. The name must be unique within the set."},"category":{"type":"string","description":"The category (i.e. status type) for this custom status. Possible values are `not started`, `started`, `needs info`, or `completed`."},"status_set_id":{"type":"integer","format":"int32","description":"The ID of the task status set to add the custom status to."}},"required":["status","category","status_set_id"]}}},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"type":"object","properties":{"custom_task_status":{"type":"object","properties":{"status":{"type":"string","description":"The name of the custom task status. The name must be unique within the set."},"position":{"type":"integer","format":"int32","description":"The order to place the custom task status within the set."}}}}},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"user_group_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/UserWorkspaceGroup"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workspace_groups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceGroup"}}}},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"type":"object","properties":{"user_group_membership":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32","description":"The ID of the user to add to the Workspace Group."},"workspace_group_id":{"type":"integer","format":"int32","description":"The ID of the Workspace Group to add the user to."}},"required":["user_id","workspace_group_id"]}}},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["bio","website","city","state","country","abbreviated_timezone","last_site_activity","classification"]}},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}},"skills":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Skill"}},"skill_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SkillMembership"}},"account_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountMembership"}},"work_samples":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkSample"}},"custom_field_values":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldValue"}}}},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"type":"object","properties":{"user":{"type":"object","properties":{"full_name":{"type":"string","description":"The full name of the user."},"headline":{"type":"string","description":"A short description of the user."},"email_address":{"type":"string","description":"The email address for the user. If this value is different than the user's existing email_address it will require a new verification."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"type":"object","properties":{"start_date":{"type":"string","format":"date","description":"The start date for calculating my work capacity in YYYY-MM-DD format (e.g. 2012-09-27)."},"end_date":{"type":"string","format":"date","description":"The end date for calculating my work capacity in YYYY-MM-DD format (e.g. 2012-09-27)."},"hours":{"type":"object","additionalProperties":{"type":"number","format":"float","description":"The key is the date, and the value is my work capacity on that date."}}}},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"type":"object","properties":{"user":{"type":"object","properties":{"profile_photo_attachment_file":{"type":"string","description":"The multipart/form-data encoded file contents. This is similar to the `data` attribute\nof the [Attachment](/tag/Attachments#operation/create-attachment) field."}},"required":["profile_photo_attachment_file"]}}},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"type":"object","properties":{"iso_code":{"type":"string","description":"ISO alphabetic code (for example, `USD`)."},"name":{"type":"string","description":"Name of currency (for example, `United States Dollar`)."},"symbol":{"type":"string","description":"Symbol associated with currency (for example, `$`)."},"subunit_to_unit":{"type":"integer","format":"int32","description":"Number of subunits in one unit for currency."}}},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"type":"string","default":"position:asc"},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"custom_field_choices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldChoice"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"custom_fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomField"}}}},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"custom_field_sets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldSet"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"custom_fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomField"}}}},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"type":"object","properties":{"custom_field_set":{"type":"object","properties":{"name":{"type":"string","description":"The name of the custom field set."},"subject_type":{"type":"string","description":"The type of objects contained by the custom field set. The supported subjects\nare currently Workspace, Story, User, and WorkspaceGroup."}},"required":["name","subject_type"]}}},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"type":"object","properties":{"custom_field_set":{"type":"object","properties":{"name":{"type":"string","description":"The name of the custom field set."},"subject_type":{"type":"string","description":"Subject type cannot be changed."}}}}},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"custom_field_values":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldValue"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"custom_fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomField"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"custom_field_choices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldChoice"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"workspace_groups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceGroup"}}}},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"type":"object","properties":{"custom_field_value":{"type":"object","properties":{"subject_type":{"type":"string","description":"You must specify which set of Custom Fields to return values for:\n* `Estimate`\n* `Story` (Task)\n* `User`\n* `Workspace` (Project)\n* `WorkspaceGroup` (Group)\n* `Resource`\n\nThis parameter is required."},"subject_id":{"type":"integer","format":"int32","description":"The ID of the Estimate, Project, Group, Resource, Task, or User the custom field is for."},"custom_field_id":{"type":"integer","format":"int32","description":"The ID of the Custom Field to create or update the value for."},"value":{"type":"string","description":"The value to create or update to for the specified custom field.\n\nValues can be created or updated in these formats:\n\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |\n\n##### Note:\nThe `write_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to edit the value of each custom field.\n* Editing `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific changes,\nso permissions are set at the project level:\n- `project_collaboration`\n- `time_logging`\n- `financial`\n- `project_admin` (default)\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators\nare able to edit all Project, Resource, and Task custom fields and values across the account,\nregardless of project participation or `write_access` settings.\n* Editing `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide changes,\nso permissions are set at the account level:\n- `account_collaboration`\n- `project_creator`\n- `project_lead`\n- `reports_viewer`\n- `reports_viewer_with_cost`\n- `account_admin` (default)."}},"required":["subject_type","subject_id","custom_field_id","value"]}}},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"type":"object","properties":{"custom_field_value":{"type":"object","properties":{"value":{"type":"string","description":"The new value that replaces the existing value for the specified custom field.\n\nThese value types are updated in the following formats:\n\n | Value Type | Format | Sample |\n | -------------------- |:----------------------------------------:| --------------:|\n | `string` | `` | `\"foo\"` |\n | `date` | `` | `\"2014-02-25\"` |\n | `number` | `` | `13` |\n | `currency` | `[, ]`| `[998, \"USD\"]` |\n | `single` and `multi` | `[]` | `[1, 2, 4]` |\n\nFor [single or multi choice](/tag/Custom-Field-Choices) Custom Fields,\nyou can think of selected choice(s) as a list, even with only 1 selected choice. The list of values in your\nrequest becomes the new list of selected choices. And the new choices all have new, unique choice IDs.\n\n##### Note:\nThe `write_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to edit the value of each custom field.\n* Editing `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific changes,\nso permissions are set at the project level:\n- `project_collaboration`\n- `time_logging`\n- `financial`\n- `project_admin` (default)\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators\nare able to edit all Project, Resource, and Task custom fields and values across the account,\nregardless of project participation or `write_access` settings.\n* Editing `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide changes,\nso permissions are set at the account level:\n- `account_collaboration`\n- `project_creator`\n- `project_lead`\n- `reports_viewer`\n- `reports_viewer_with_cost`\n- `account_admin` (default)."}},"required":["value"]}}},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"type":"string","default":"name:asc"},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"custom_fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomField"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"custom_field_choices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldChoice"}},"custom_field_sets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldSet"}}}},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"type":"object","properties":{"custom_field":{"type":"object","properties":{"name":{"type":"string","description":"The name of the new field."},"value_type":{"type":"string","description":"The format of the [custom field's value](/tag/Custom-Field-Values):\n| Value Type | Format | Sample |\n| -------------------- |:----------------------------------------:| --------------:|\n| `string` | `` | `\"foo\"` |\n| `date` | `` | `\"2014-02-25\"` |\n| `number` | `` | `13` |\n| `currency` | `[, ]`| `[998, \"USD\"]` |\n| `single` and `multi` | `[]` | `[1, 2, 4]` |\n\nThis is set to `string` by default."},"default_text":{"type":"string","description":"The message in an empty custom field, before a `string`, `date`, `number`, or `currency` value is entered in.\nThis only appears in the UI."},"unique_constraint":{"type":"boolean","description":"A boolean setting that requires a custom field value to be unique across Estimates, Projects, Groups,\nResources, Tasks, or Users.\n\nThis is set to `false` by default."},"choices":{"type":"array","description":"The list of [choices](/tag/Custom-Field-Choices) a user can select from\nfor a custom field's value(s). A choice has two attributes, a `label` and an `ID`. Different choices can have the\nsame `label`, but every choice will have a unique `ID`.\n\nFor example, a request:\n\n```\ncustom_field_choices: {\n ....\n choices: [\n { \"label\": \"Choice A\" },\n { \"label\": \"Choice B\" },\n { \"label\": \"Choice B\" },\n { \"label\": \"Choice B\" }\n ]\n ....\n}\n\nWill have a response like:\n\n```\ncustom_field_choices: {\n ....\n choices: [\n { \"label\": \"Choice A\", \"id\": \"180291\" },\n { \"label\": \"Choice B\", \"id\": \"180301\" },\n { \"label\": \"Choice B\", \"id\": \"180311\" },\n { \"label\": \"Choice B\", \"id\": \"180321\" }\n ]\n ....\n}\n```\n\nChoices in the UI appear in the same order as listed in the array.\n\nNote that the 2nd, 3rd, and 4th choices all have the same label, but different IDs.","items":{"type":"object","properties":{"label":{"type":"string","description":"You can think of a label as the actual value a user can select for the custom field.\n\n*Note:* Different choices can have the same `label`."}}}},"custom_field_set_id":{"type":"integer","format":"int32","description":"The ID of the [Custom Field Set](/tag/Custom-Field-Sets) that the field belongs to.\nWhen a set ID is not specified, the field is added to a Project set titled 'Default Project Set'.\nThis means it becomes a Project field."},"write_access":{"type":"string","description":"The permission level required for a user to create, update, or delete a custom field's value."},"read_access":{"type":"string","description":"The `read_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to view a custom field and its value.\n* `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific objects,\nso their minimum permissions are set at the [project level](https://mavenlink.zendesk.com/hc/en-us/articles/115002779293-Project-Permissions):\n - `project_collaboration` (default)\n - `time_logging`\n - `financial`\n - `project_admin`\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators are able to view\nall Project, Resource, and Task custom fields and values across the account, regardless of project participation or\n`read_access` settings.\n* `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide objects, so their minimum permissions\nare set at the [account level](https://mavenlink.zendesk.com/hc/en-us/articles/203041364):\n - `account_collaboration`\n - `project_creator`\n - `project_lead`\n - `reports_viewer`\n - `reports_viewer_with_cost`\n - `account_admin` (default)."}},"required":["name"]}}},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"type":"object","properties":{"custom_field":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field."},"default_text":{"type":"string","description":"The message in an empty custom field, before a `string`, `date`, `number`, or `currency` value is entered in.\nThis only appears in the UI."},"choices":{"type":"array","description":"The list of [choices](/tag/Custom-Field-Choices) a user can select from,\nfor a custom field's value(s). Setting this field updates a custom field's\ncomplete list of choices; it behaves as an overwrite.\n**Include all existing choices in your request, whether you are updating their `label` or not.**\nAny choices not included in your request *will be deleted* from the custom field.\n\n**How to avoid creating duplicate choices**\n\nChoices have two attributes, a `label` and an `ID`. Different choices can have the same `label`,\nbut every choice has a unique `ID`. To properly update an existing choice within a list, you must specify the `ID`\nof the choice you want to change. If you do not, a new choice with a unique, new `ID` is created instead.\n\nFor example:\n\n```\ncustom_field_choices: {\n ....\n choices: [\n { \"label\": \"Choice A\", \"id\": \"180291\" },\n { \"label\": \"Choice B\", \"id\": \"180301\" },\n { \"label\": \"Choice C\" }\n ]\n ....\n}\n```\n\nChoices in the UI appear in the same order as listed in the array.\n\nThe 1st choice is an existing choice with an ID of `180291`, and is either staying or being updated to `Choice A`.\nThe 2nd choice is an existing choice with an ID of `180301`, and is either staying or being updated to `Choice B`.\nThe 3rd choice is a new choice to create, `Choice C`, and its unique ID will be returned in the response.","items":{"type":"object","properties":{"label":{"type":"string","description":"You can think of a label as the actual value a user can select for the custom field.\n\n*Note:* Different choices can have the same `label`."},"id":{"type":"integer","format":"int32","description":"The unique ID of an existing choice(s). If you do not specify the `ID` of an existing choice in an update request,\na new choice with a unique, new `ID` is generated instead. Use this parameter to avoid replacing\nexisting choices with new ones."}}}},"custom_field_set_id":{"type":"integer","format":"int32","description":"The ID of the [Custom Field Set](/tag/Custom-Field-Sets) that the field belongs to.\nWhen a set ID is not specified, the field is added to a Project set titled 'Default Project Set'.\nThis means it becomes a Project field."},"write_access":{"type":"string","description":"The permission level required for a user to create, update, or delete a custom field value for a subject."},"read_access":{"type":"string","description":"The `read_access` [permission setting on each custom field](https://mavenlink.zendesk.com/hc/en-us/articles/202924760#see)\ndetermines the minimum permission needed to view a custom field and its value.\n* `Workspace` (Project), `Resource`, and `Story` (Task) custom fields are project-specific objects,\nso their minimum permissions are set at the [project level](https://mavenlink.zendesk.com/hc/en-us/articles/115002779293-Project-Permissions):\n - `project_collaboration` (default)\n - `time_logging`\n - `financial`\n - `project_admin`\n\nMost account-level permissions supercede project-level permissions. Therefore, Account Administrators\nare able to view all Project, Resource, and Task custom fields and values across the account,\nregardless of project participation or `read_access` settings.\n* `Estimate`, `WorkspaceGroup` (Group), and `User` custom fields are account-wide objects,\nso their minimum permissions are set at the [account level](https://mavenlink.zendesk.com/hc/en-us/articles/203041364):\n - `account_collaboration`\n - `project_creator`\n - `project_lead`\n - `reports_viewer`\n - `reports_viewer_with_cost`\n - `account_admin` (default)."}}}}},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"type":"object","properties":{"datasets":{"type":"object","description":"The `key`, `display_name`, and `columns` for a data set.","additionalProperties":{"type":"object","description":"The `key` value for a data set.","properties":{"key":{"type":"string","description":"The `key` value for a data set."},"display_name":{"type":"string","description":"The name of a data set as it appears in the Data Exporter."},"columns":{"type":"array","description":"The `key` value and `display_name` for a column in a data set.","items":{"type":"object","properties":{"key":{"type":"string","description":"The `key` value for a column in a data set."},"display_name":{"type":"string","description":"The name of a column as it appears in the Data Exporter."},"description":{"type":"string","description":"The description of a column in an export."},"type":{"type":"string","description":"The data type of a column."}}}}}}}}},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"exports":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountDataExportResult"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}}}},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"type":"object","properties":{"export":{"type":"object","properties":{"export_definition":{"type":"object","additionalProperties":{"type":"object","description":"The `key` value for the data set you want to export.","properties":{"columns":{"type":"array","items":{"type":"string"},"description":"The `key` values for each column you want to include in the export."},"filters":{"type":"object","description":"The filters that you want to apply to the export.","properties":{"start_date":{"type":"string","format":"date","description":"The start date to filter the export by, which restricts data to objects that were created on or after the given date. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"end_date":{"type":"string","format":"date","description":"The end date to filter the export by, which restricts data to objects that were created on or before the given date. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}}}},"required":["columns"]}}},"required":["export_definition"]}}},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"type":"object","properties":{"export":{"type":"object","properties":{"canceled":{"type":"boolean","description":"If set to `true`, cancels an export with a Queued status."}}}}},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"type":"object","properties":{"download_url":{"type":"string","description":"The URL to download a generated data export that expires in 60 seconds."}}},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"type":"object","properties":{"estimate_scenario_resource_allocation":{"type":"object","properties":{"duration_days":{"type":"integer","format":"int32","description":"The length of time for the allocation (in days)."},"percent_allocated":{"type":"number","format":"float","description":"The percentage allocated. This must be a decimal number between (and including) 0 and 1."},"relative_start_day":{"type":"integer","format":"int32","description":"The number of business days, after the start date of the project, that the resource\nwill begin working on the project."}}}}},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"estimate_scenario_resource_allocations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EstimateScenarioResourceAllocation"}},"estimate_scenario_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EstimateScenarioResource"}}}},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"type":"string","default":"updated_at:desc"},"id":"schema_391"},"schema_392":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"estimate_scenario_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EstimateScenarioResource"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}},"organization_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/OrganizationMembership"}},"estimate_scenario_resource_allocations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EstimateScenarioResourceAllocation"}},"organizations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Geography"}}}},"id":"schema_392"},"schema_393":{"kind":"json-schema","data":{"type":"object","properties":{"estimate_scenario_resource":{"type":"object","properties":{"estimate_scenario_id":{"type":"integer","format":"int32","description":"The estimate scenario to which the resource is attached."},"label":{"type":"string","description":"The name of the resource. An auto-generated label will be supplied if not present."},"role_id":{"type":"integer","format":"int32","description":"The role with which the resource will be associated."},"allocation_attributes":{"type":"object","properties":{"duration_days":{"type":"integer","format":"int32","description":"The number of business days a resource is expected to work on the project."},"percent_allocated":{"type":"number","format":"float","description":"The percentage of available hours the resource will work on the project."},"relative_start_day":{"type":"integer","format":"int32","description":"The zero-based day that a scenario resource is expected to start working on the project, relative\nto the start date of the estimate scenario."}}},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["estimate_scenario_id","role_id"]}}},"id":"schema_393"},"schema_394":{"kind":"json-schema","data":{"type":"object","properties":{"estimate_scenario_resource":{"type":"object","properties":{"role_id":{"type":"integer","format":"int32","description":"The role with which the resource will be associated."},"label":{"type":"string","description":"The name of the resource."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["role_id"]}}},"id":"schema_394"},"schema_395":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"estimate_scenarios":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EstimateScenario"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"rate_cards":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCard"}},"estimate_scenario_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EstimateScenarioResource"}}}},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"type":"object","properties":{"estimate_scenario":{"type":"object","properties":{"name":{"type":"string","description":"The name of the scenario (must be a unique name within it's estimate)."},"estimate_id":{"type":"integer","format":"int32","description":"The ID of the estimate that is associated with the scenario."},"start_date":{"type":"string","format":"date","description":"The planned start date of the project. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"budget_in_cents":{"type":"integer","format":"int32","description":"The planned budget for the scenario."},"rate_card_id":{"type":"integer","format":"int32","description":"The rate card being used to calculate the resources' rates. If this is not provided,\na rate card with the same currency as the estimate will be selected from the\naccount default rate cards."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["name","estimate_id","start_date"]}}},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"type":"object","properties":{"estimate_scenario":{"type":"object","properties":{"budget_in_cents":{"type":"integer","format":"int32","description":"The planned budget for the scenario."},"name":{"type":"string","description":"The name of the scenario (must be a unique name within it's estimate)."},"rate_card_id":{"type":"integer","format":"int32","description":"The rate card being used to calculate the resources' rates."},"start_date":{"type":"string","format":"date","description":"The planned start date of the project. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"estimates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Estimate"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workspace_groups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceGroup"}},"estimate_scenarios":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EstimateScenario"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"custom_field_values":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldValue"}}}},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"type":"object","properties":{"estimate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the estimate."},"currency":{"type":"string","description":"The currency of the estimate, by code (for example, 'AUD' or 'USD')."},"workspace_group_id":{"type":"integer","format":"int32","description":"The ID of the workspace group (client) of the estimate."},"estimate_scenario":{"type":"object","description":"The estimated budget, start date, and rate card associated with the estimate.","properties":{"name":{"type":"string","description":"The name of the scenario (must be unique within it's estimate)."},"start_date":{"type":"string","format":"date","description":"The planned start date of the project. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"budget_in_cents":{"type":"integer","format":"int32","description":"The planned budget for this scenario."},"rate_card_id":{"type":"integer","format":"int32","description":"The rate card being used to calculate the resources' rates."}},"required":["name","start_date"]},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["name","currency"]}}},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"type":"object","properties":{"estimate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Estimate."},"workspace_group_id":{"type":"integer","format":"int32","description":"The Client the Estimate is created for."},"description":{"type":"string","description":"The description of the estimate."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_400"},"schema_401":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"expense_budgets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExpenseBudget"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"expenses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Expense"}},"fixed_fee_items":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FixedFeeItem"}}}},"id":"schema_401"},"schema_402":{"kind":"json-schema","data":{"type":"object","properties":{"expense_budget":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the workspace to create the expense budget for."},"title":{"type":"string","description":"The name of the expense budget."},"description":{"type":"string","description":"The description of the expense budget."},"fixed_fee":{"type":"boolean","description":"Whether the expense will be billed as a fixed cost."},"burns_budget":{"type":"boolean","description":"Whether the expense budget affects the project margin."},"billable":{"type":"boolean","description":"Whether the expense will be billed to the client."},"expected_by":{"type":"string","format":"date","description":"When the expenses are expected to be logged by. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"story_id":{"type":"integer","format":"int32","description":"The ID of the story (task) to associate this expense budget to."},"cost_per_unit_in_subunits":{"type":"integer","format":"int32","description":"The cost, in the subunits of the currency (e.g. cents for USD)."},"markup_per_unit_in_subunits":{"type":"integer","format":"int32","description":"When the `markup_type` is set to `flat_fee`, this is the markup per unit,\nin the subunits of the currency (e.g. cents for USD). This is\nmultiplied by the `quantity` and added to the total cost to produce the\ntotal fees."},"quantity":{"type":"integer","format":"int32","description":"The number of units."},"markup_type":{"type":"string","description":"The markup type. Options are `percentage` and `flat_fee`. If not set, no markup is applied."},"markup_percentage":{"type":"number","format":"float","description":"When the `markup_type` is set to `percentage`, this is the markup percentage.\nThis is multiplied by the total cost to produce the total markup,\nthen added to the total cost to produce the total fees."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["workspace_id","title","fixed_fee","burns_budget","billable"]}}},"id":"schema_402"},"schema_403":{"kind":"json-schema","data":{"type":"object","properties":{"expense_budget":{"type":"object","properties":{"title":{"type":"string","description":"The name of the expense budget."},"description":{"type":"string","description":"The description of the expense budget."},"fixed_fee":{"type":"boolean","description":"Whether the expense will be billed as a fixed cost."},"burns_budget":{"type":"boolean","description":"Whether the expense budget affects the project margin."},"billable":{"type":"boolean","description":"Whether the expense will be billed to the client."},"expected_by":{"type":"string","format":"date","description":"When the expenses are expected to be logged by. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"story_id":{"type":"integer","format":"int32","description":"The ID of the story (task) to associate this expense budget to."},"cost_per_unit_in_subunits":{"type":"integer","format":"int32","description":"The cost, in the subunits of the currency (e.g. cents for USD)."},"quantity":{"type":"integer","format":"int32","description":"The number of units."},"markup_type":{"type":"string","description":"The markup type. Options are `percentage` and `flat_fee`. If not set, no markup is applied."},"markup_percentage":{"type":"number","format":"float","description":"When the `markup_type` is set to `percentage`, this is the markup percentage.\nThis is multiplied by the total cost to produce the total markup,\nthen added to the total cost to produce the total fees."},"markup_per_unit_in_subunits":{"type":"integer","format":"int32","description":"When the `markup_type` is set to `flat_fee`, this is the markup per unit,\nin the subunits of the currency (e.g. cents for USD). This is\nmultiplied by the `quantity` and added to the total cost to produce the\ntotal fees."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_403"},"schema_404":{"kind":"json-schema","data":{"type":"object","properties":{"attachment":{"type":"object","properties":{"type":{"type":"string","description":"Indicates the type of Attachment within Kantata OX. Allowed values are: receipt or post_attachment.\nA receipt is attached to an Expense, and a post_attachment is attached to a Post."},"direct":{"type":"boolean","description":"Whether or not this is a direct CDN upload. If direct is set to true, the filename field is required.\nIf direct is set to false or is not present, the data field is required."},"data":{"type":"string","description":"The multipart/form-data encoded file contents. Only used if direct is not set to true. Note that the\nmaximum allowed size for file data uploads is 10MB. For larger files, use a direct CDN upload."},"filename":{"type":"string","description":"The filename of the file to be uploaded. Only used if direct is set to true."}},"required":["type"]}}},"id":"schema_404"},"schema_405":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"attachments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Attachments_Base"}}}},"id":"schema_405"},"schema_406":{"kind":"json-schema","data":{"type":"object","properties":{"attachment":{"type":"object","properties":{"filename":{"type":"string","description":"Used to rename an already existing attachment within Kantata OX."}}}}},"id":"schema_406"},"schema_407":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"expense_categories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExpenseCategory"}}}},"id":"schema_407"},"schema_408":{"kind":"json-schema","data":{"type":"object","properties":{"expense_category":{"type":"object","properties":{"name":{"type":"string","description":"The name of the expense category."}},"required":["name"]}}},"id":"schema_408"},"schema_409":{"kind":"json-schema","data":{"type":"object","properties":{"expense_category":{"type":"object","properties":{"name":{"type":"string","description":"The name of the expense category."}}}}},"id":"schema_409"},"schema_410":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"expense_report_submissions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExpenseReportSubmission"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"expenses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Expense"}},"resolutions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Resolution"}}}},"id":"schema_410"},"schema_411":{"kind":"json-schema","data":{"type":"object","properties":{"expense_report_submission":{"type":"object","properties":{"line_item_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"An array of expense ids of the expenses that will be included in the Expense Report Submission."},"user_id":{"type":"integer","format":"int32","description":"This can be included when the Expense Report Submission is being submitted on behalf of another user."},"title":{"type":"string","description":"The title of the Expense Report Submission."},"workspace_id":{"type":"integer","format":"int32","description":"The id of the workspace that will own the Expense Report Submission and its expenses."},"comment":{"type":"string","description":"Additional notes on the Expense Report Submission."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["line_item_ids","title","workspace_id"]}}},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"type":"object","properties":{"resolution":{"type":"object","properties":{"description":{"type":"string","description":"Any additional details about the resolution can be added in the description."}}}}},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["user_can_edit"]}},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"type":"string","default":"date:desc"},"id":"schema_414"},"schema_415":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"expenses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Expense"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"attachments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Attachments_ReceiptAttachment"}},"expense_report_submissions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExpenseReportSubmission"}},"expense_categories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExpenseCategory"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}},"vendors":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Vendor"}},"expense_budgets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExpenseBudget"}}}},"id":"schema_415"},"schema_416":{"kind":"json-schema","data":{"type":"object","properties":{"expense":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project in which the expense will be created."},"date":{"type":"string","format":"date","description":"The date of the expense. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"expense_category_id":{"type":"integer","format":"int32","description":"The ID of the category with which the expense will be associated."},"category":{"type":"string","description":"The category of the expense as a string."},"amount_in_cents":{"type":"integer","format":"int32","description":"The amount of the expense, in cents. If 'foreign_exchange_amount' is specified, that overrides the 'amount_in_cents'."},"foreign_exchange_amount":{"type":"object","description":"If you have permission to convert expenses, this is the expense in foreign currency units.","properties":{"source_value":{"type":"string","description":"The amount of the expense, in foreign currency units."},"source_currency":{"type":"string","description":"The [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473-Supported-Currency-ISO-Codes) of the foreign currency in which the expense was incurred."}},"required":["source_value","source_currency"]},"user_id":{"type":"integer","format":"int32","description":"The internal ID of the user the expense is associated with. This parameter is ignored unless the\nauthorizing user has financial access in the project and is on the consultants team (or if the\nauthorizing user is an account administrator and has proxy permissions via an account member with\nthose permissions)."},"notes":{"type":"string","description":"Freeform text related to the expense."},"billable":{"type":"boolean","description":"A boolean that indicates whether or not the expense is billable."},"receipt_id":{"type":"integer","format":"int32","description":"The optional ID of an attached receipt for the expense."},"story_id":{"type":"integer","format":"int32","description":"The optional ID of a task in the project (this will be linked to this expense). Depending on the\nproject's settings, expenses can be associated with only expense budgets or only tasks."},"expense_budget_id":{"type":"integer","format":"int32","description":"The optional ID of an expense budget in the project (this will be linked to this expense). Depending\non the project's settings, expenses can be associated with only expense budgets or only tasks."},"reimbursable":{"type":"boolean","description":"A boolean that indicates whether the expense is reimbursable to the user."},"vendor_id":{"type":"integer","format":"int32","description":"The optional ID of the vendor to which the expense is reimbursable."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["workspace_id","date","expense_category_id","category","amount_in_cents"]}}},"id":"schema_416"},"schema_417":{"kind":"json-schema","data":{"type":"object","properties":{"deleted":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of the expenses that were deleted."}}},"id":"schema_417"},"schema_418":{"kind":"json-schema","data":{"type":"object","properties":{"expense":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project in which the expense will be associated."},"date":{"type":"string","format":"date","description":"The date of the expense in ISO8601 format. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"expense_category_id":{"type":"integer","format":"int32","description":"The ID of the category to which the expense will be associated."},"category":{"type":"string","description":"The category of the expense as a string."},"amount_in_cents":{"type":"integer","format":"int32","description":"The amount of the expense, in cents. If 'foreign_exchange_amount' is specified, that overrides the 'amount_in_cents'."},"foreign_exchange_amount":{"type":"object","description":"If you have permission to convert expenses, this is the expense in foreign currency units.","properties":{"source_value":{"type":"string","description":"The amount of the expense, in foreign currency units."},"source_currency":{"type":"string","description":"The [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473-Supported-Currency-ISO-Codes) of the foreign currency in which the expense was incurred."}},"required":["source_value","source_currency"]},"user_id":{"type":"integer","format":"int32","description":"The internal ID of the user with whom the expense is associated. This parameter is ignored unless the\nauthorizing user has financial access in the project and is on the consultants team; or if they\nare an Account Administrator that has proxy permissions through an account member with the necessary permissions."},"notes":{"type":"string","description":"Freeform text related to the expense."},"billable":{"type":"boolean","description":"A boolean that indicates whether or not this expense is billable."},"receipt_id":{"type":"integer","format":"int32","description":"The optional ID of an attached receipt for this expense."},"story_id":{"type":"integer","format":"int32","description":"The optional ID of a task in the project (this will be linked to this expense). Depending on the\nproject's settings, expenses can be associated with only expense budgets or only tasks."},"expense_budget_id":{"type":"integer","format":"int32","description":"The optional ID of an expense budget in the project (this will be linked to this expense). Depending\non the project's settings, expenses can be associated with only expense budgets or only tasks."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"vendors":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Vendor"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}}}},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"type":"object","properties":{"vendor":{"type":"object","properties":{"name":{"type":"string","description":"The name of the vendor."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["name"]}}},"id":"schema_420"},"schema_421":{"kind":"json-schema","data":{"type":"object","properties":{"vendor":{"type":"object","properties":{"name":{"type":"string","description":"The name of the vendor."},"archived":{"type":"boolean","description":"When set to true, archives the vendor."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"type":"string","default":"last_synced_at:desc"},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"assignments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Assignment"}},"billing_milestones":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BillingMilestone"}},"custom_fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomField"}},"custom_field_choices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldChoice"}},"custom_field_sets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldSet"}},"custom_field_values":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldValue"}},"estimates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Estimate"}},"estimate_scenarios":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EstimateScenario"}},"estimate_scenario_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EstimateScenarioResource"}},"expenses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Expense"}},"expense_budgets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExpenseBudget"}},"invoices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Invoice"}},"participations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Participation"}},"posts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Post"}},"rate_cards":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCard"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}},"skills":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Skill"}},"status_reports":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StatusReport"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"story_allocation_days":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StoryAllocationDay"}},"submissions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Submission"}},"survey_answers":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyAnswer"}},"survey_questions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyQuestion"}},"survey_responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyResponse"}},"survey_templates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyTemplate"}},"time_entries":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TimeEntry"}},"time_off_entries":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TimeOffEntry"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"vendors":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Vendor"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"workspace_allocations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceAllocation"}},"workspace_groups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceGroup"}},"workspace_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceResource"}}}},"id":"schema_423"},"schema_424":{"kind":"json-schema","data":{"type":"object","properties":{"external_reference":{"type":"object","properties":{"subject_type":{"type":"string","description":"The type of the Kantata OX object to which this external reference belongs.\nOne of `Assignment`, `BillingMilestone`, `CustomField`, `CustomFieldChoice`, `CustomFieldSet`, `CustomFieldValue`, `Estimate`, `EstimateScenario`, `EstimateScenarioResource`, `Expense`, `ExpenseBudget`, `Invoice`, `Participation`, `Post`, `RateCard`, `Role`, `Skill`, `StatusReport`, `Story`, `StoryAllocationDay`, `Submission`, `SurveyAnswer`, `SurveyQuestion`, `SurveyResponse`, `SurveyTemplate`, `TimeEntry`, `TimeOffEntry`, `User`, `Vendor`, `Workspace`, `WorkspaceAllocation`, `WorkspaceGroup`, or `WorkspaceResource`."},"subject_id":{"type":"integer","format":"int32","description":"The ID of the Kantata OX object to which this external reference belongs."},"service_name":{"type":"string","description":"The provider name of the integration."},"service_model":{"type":"string","description":"The type of the external object to which this reference belongs."},"service_model_ref":{"type":"string","description":"The ID of the external object to which this external reference belongs."},"status":{"type":"string","description":"The status of the integration. Options are 'pending', 'successful', or 'failed'."},"external_link":{"type":"string","description":"A URL that links to either the external object or event."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"external_message":{"type":"string","description":"An optional message about the external object."},"locked":{"type":"boolean","description":"An optional field, indicates whether the subject should be locked. To prevent changes\nto the object in Kantata OX, set this to true. This currently only applies to expense\nreport rejections."}},"required":["subject_type","subject_id","service_name","service_model","service_model_ref"]}}},"id":"schema_424"},"schema_425":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"billing_milestones":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BillingMilestone"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"invoices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Invoice"}}}},"id":"schema_425"},"schema_426":{"kind":"json-schema","data":{"type":"object","properties":{"billing_milestone":{"type":"object","properties":{"title":{"type":"string","description":"The title of the billing milestone."},"amount_in_cents":{"type":"integer","format":"int32","description":"The billing milestone amount, in the subunits of the currency (e.g. cents for USD). Values can also be negative (e.g. `-10000`)."},"date_to_invoice":{"type":"string","format":"date","description":"The date that the billing milestone becomes invoiceable. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"workspace_id":{"type":"integer","format":"int32","description":"The ID of the workspace associated with the billing milestone."},"story_id":{"type":"integer","format":"int32","description":"The ID of the story associated with the billing milestone. This field is required when the `billing_type` is set to `upon_completion`."},"billing_type":{"type":"string","description":"The billing type of the milestone. Can be 'fixed_date' or 'upon_completion'."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["title","amount_in_cents","workspace_id"]},"billing_milestones":{"type":"array","description":"Add multiple billing milestones and their attributes in an array.","items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the billing milestone."},"amount_in_cents":{"type":"integer","format":"int32","description":"The billing milestone amount, in the subunits of the currency (e.g. cents for USD). Values can also be negative (e.g. `-10000`)."},"date_to_invoice":{"type":"string","format":"date","description":"The date that the billing milestone becomes invoiceable. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"workspace_id":{"type":"integer","format":"int32","description":"The ID of the workspace associated with the billing milestone."},"story_id":{"type":"integer","format":"int32","description":"The ID of the story associated with the billing milestone. This field is required when the `billing_type` is set to `upon_completion`."},"billing_type":{"type":"string","description":"The billing type of the milestone. Can be 'fixed_date' or 'upon_completion'."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["title","amount_in_cents","workspace_id"]}}}},"id":"schema_426"},"schema_427":{"kind":"json-schema","data":{"type":"object","properties":{"billing_milestone":{"type":"object","properties":{"title":{"type":"string","description":"The title of the billing milestone."},"amount_in_cents":{"type":"integer","format":"int32","description":"The billing milestone amount, in the subunits of the currency (e.g. cents for USD)."},"date_to_invoice":{"type":"string","format":"date","description":"The date that the billing milestone becomes invoiceable. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"billing_type":{"type":"string","description":"The billing type of the milestone. Can be 'fixed_date' or 'upon_completion'."},"story_id":{"type":"integer","format":"int32","description":"The ID of the story associated with the billing milestone. This field is required when the `billing_type` is set to `upon_completion`."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_427"},"schema_428":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","description":"An array of ordered pointers for the items in the `revenue_recognition_methods` top-level object.","items":{"type":"object","properties":{"key":{"type":"string","description":"The `key` is always `revenue_recognition_methods`."},"id":{"type":"string","description":"Composite ID, formatted as `:` (e.g. `42:percent_complete`)."},"name":{"type":"string","description":"The name of the revenue recognition method."}}}},"revenue_recognition_methods":{"type":"object","description":"Revenue recognition methods determine how revenue is recognized. Methods are configured at the account level, then each project can have an available method applied.","additionalProperties":{"type":"object","description":"A single revenue recognition method, keyed by its composite ID in the format `:` (e.g. `42:percent_complete`).","properties":{"id":{"type":"string","description":"The ID of the revenue recognition method. The ID is in the following format: `id:revenue_recognition_method_type`."},"account_id":{"type":"integer","format":"int32","description":"The ID of the account which the revenue recognition method is on."},"name":{"type":"string","description":"The name of the revenue recognition method."},"revenue_to_date_formula":{"type":"string","description":"The formula to calculate the revenue to date."},"revenue_in_period_formula":{"type":"string","description":"The formula to calculate the revenue in period."},"created_at":{"type":"string","format":"date-time","description":"When the revenue recognition method was created."},"updated_at":{"type":"string","format":"date-time","description":"When the revenue recognition method was updated."},"active":{"type":"boolean","description":"Whether the revenue recognition method can be selected for a project."},"type":{"type":"string","description":"The type of revenue recognition method. Possible values are `percent_complete` and `time_and_materials`."},"percent_complete_formula":{"type":"string","description":"The formula to calculate percent complete. Only applicable for `percent_complete` methods."}}}}}},"id":"schema_428"},"schema_429":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Number of exchange tables in the response."},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Number of exchange tables in the response."},"page_count":{"type":"integer","format":"int32","description":"Number of pagination pages available."},"page_number":{"type":"integer","format":"int32","description":"Current pagination page."},"page_size":{"type":"integer","format":"int32","description":"Number of elements in a pagination page."}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string","description":"The ID of the exchange table."}}}},"exchange_tables":{"type":"object","properties":{"id":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the exchange table."},"name":{"type":"string","description":"The name of the exchange table."},"account_default":{"type":"boolean","description":"If true, this is set as the default exchange table for currency conversions across your entire account."},"insights_account_default":{"type":"boolean","description":"If true, this is set as the default exchange table for currency conversions in Insights reports."}}}}}}},"id":"schema_429"},"schema_430":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the exchange table."},"name":{"type":"string","description":"The name of the exchange table."},"account_default":{"type":"boolean","description":"If true, this is set as the default exchange table for currency conversions across your entire account."},"insights_account_default":{"type":"boolean","description":"If true, this is set as the default exchange table for currency conversions in Insights reports."}}}}},"id":"schema_430"},"schema_431":{"kind":"json-schema","data":{"type":"object","properties":{"exchange_rates":{"type":"array","description":"An array of hashes represents an entire exchange rate table, while each hash represents a row in the table. Each row (hash) contains four (4) fields that make up a currency conversion, organized by columns in a table. These fields are source currency, target currency, effective date, and exchange rate of each currency conversion. Add hashes to define a new currency exchange, or modify the fields of existing hashes to update those currency conversions.","items":{"type":"object","properties":{"source_currency":{"type":"string","description":"The currency you are converting from."},"target_currency":{"type":"string","description":"The currency you are converting to."},"effective_date":{"type":"string","format":"date","description":"The date the exchange rate takes effect. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"exchange_rate":{"type":"string","description":"The rate of the exchange from source to target currency. For example, a rate of 1.53 for a USD (source) to AUD (target) conversion would mean 1USD = 1.53AUD."}}}}}},"id":"schema_431"},"schema_432":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Number of exchange tables in the response."},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Number of exchange tables in the response."},"page_count":{"type":"integer","format":"int32","description":"Number of pagination pages available."},"page_number":{"type":"integer","format":"int32","description":"Current pagination page."},"page_size":{"type":"integer","format":"int32","description":"Number of elements in a pagination page."}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string","description":"The ID of the exchange table."}}}},"exchange_rates":{"type":"object","properties":{"id":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"The ID of the exchange rate."},"exchange_table_id":{"type":"integer","format":"int32","description":"The ID of the exchange table."},"source_currency":{"type":"string","description":"The currency you are converting from."},"target_currency":{"type":"string","description":"The currency you are converting to."},"effective_date":{"type":"string","format":"date","description":"The date the exchange rate takes effect."},"rate":{"type":"string","description":"The rate of the exchange from source to target currency. For example, a rate of 1.53 for a USD (source) to AUD (target) conversion\n would mean 1USD = 1.53AUD."},"source_currency_symbol":{"type":"string","description":"The symbol for the source currency."}}}}}}},"id":"schema_432"},"schema_433":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["user_name","account_permission"]}},"id":"schema_433"},"schema_434":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"insights_access_group_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/InsightsAccessGroupMembership"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}}}},"id":"schema_434"},"schema_435":{"kind":"json-schema","data":{"type":"object","properties":{"insights_access_group_membership":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32","description":"The ID of the user to add to the Insights Access Group."},"insights_access_group_id":{"type":"integer","format":"int32","description":"The ID of the Insights Access Group to add the user to."}},"required":["user_id","insights_access_group_id"]}}},"id":"schema_435"},"schema_436":{"kind":"json-schema","data":{"type":"object","properties":{"insights_access_group_membership":{"type":"object","properties":{"can_edit":{"type":"boolean","description":"Whether the user can create and edit custom classic Insights dashboards and reports.\n\n**Warning**: Giving a user `can_edit` permission gives them access to *all* account data via Insights.\n\n**Note**: It may take up to 15 minutes for the system to sync the `can_edit` field."}}}}},"id":"schema_436"},"schema_437":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"account_insights_mappings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountInsightsMapping"}}}},"id":"schema_437"},"schema_438":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"The ID of a scheduled report export."},"title":{"type":"string","description":"The name of a scheduled report export."},"description":{"type":"string","description":"The description of a scheduled report export, if provided."},"external_report_object_identifier":{"type":"string","description":"The unique identifier of the report you want to export on a schedule. Each report has one."},"recurrence":{"type":"object","description":"The schedule for when you would like the report export to repeat, defined by the `cadence` and `start_time`.","properties":{"cadence":{"type":"string","description":"How often a scheduled export runs, defined as either `hourly` or `daily`."},"start_time":{"type":"string","format":"date-time","description":"The timestamp for when a schedule begins. Daily scheduled exports recur at this time everyday. This property is only applicable to non-hourly schedules."}}},"created_at":{"type":"string","format":"date-time","description":"The timestamp for when an export of a report was completed."},"latest_success":{"type":"object","description":"Download the most recent successfully exported report.","properties":{"url":{"type":"string","description":"The URL to the most recent successful report export. Download the exported report within 60 seconds. The URL expiration period is subject to change. If you do not download the report within 60 seconds, you can send a new request to generate a new URL."},"created_at":{"type":"string","format":"date-time","description":"Timestamp for when the most recent successful report export was completed."}}}}}},"id":"schema_438"},"schema_439":{"kind":"json-schema","data":{"type":"object","properties":{"insights_report_export":{"type":"object","properties":{"title":{"type":"string","description":"Give a name for the scheduled report export."},"description":{"type":"string","description":"Give a description for the scheduled report export."},"external_report_object_identifier":{"type":"string","description":"Enter the unique identifier of the classic Insights report you want to export on a schedule. Each report has one. Use the Insights Report endpoint to get the identifier for the report you want to export."},"recurrence":{"type":"object","description":"A schedule for when you would like the report export to repeat, consisting of the `cadence` and `start_time` that you define.","properties":{"cadence":{"type":"string","description":"Define how often a scheduled export runs. Valid values: `hourly`, `daily`."},"start_time":{"type":"string","format":"date-time","description":"Define the date and time a schedule begins in ISO 8601 format. Daily scheduled exports will recur at this time everyday. This parameter is required for all non-hourly schedules. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}},"required":["cadence"]}},"required":["external_report_object_identifier","recurrence"]}}},"id":"schema_439"},"schema_440":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"The ID of a scheduled report export."},"title":{"type":"string","description":"The name of a scheduled report export."},"description":{"type":"string","description":"The description of a scheduled report export, if provided."},"external_report_object_identifier":{"type":"string","description":"The unique identifier of the report you want to export on a schedule. Each report has one."},"recurrence":{"type":"object","description":"The schedule for when you would like the report export to repeat, defined by the `cadence` and `start_time`.","properties":{"cadence":{"type":"string","description":"How often a scheduled export runs, defined as either `hourly` or `daily`."},"start_time":{"type":"string","format":"date-time","description":"The timestamp for when a schedule begins. Daily scheduled exports recur at this time everyday. This property is only applicable to non-hourly schedules."}}},"created_at":{"type":"string","format":"date-time","description":"The timestamp for when an export of a report was completed."},"latest_success":{"type":"object","description":"Download the most recent successfully exported report.","properties":{"url":{"type":"string","description":"The URL to the most recent successful report export. Download the exported report within 60 seconds. The URL expiration period is subject to change. If you do not download the report within 60 seconds, you can send a new request to generate a new URL."},"created_at":{"type":"string","format":"date-time","description":"Timestamp for when the most recent successful report export was completed."}}}}},"id":"schema_440"},"schema_441":{"kind":"json-schema","data":{"type":"object","properties":{"insights_report_export":{"type":"object","properties":{"title":{"type":"string","description":"Give a name for the scheduled report export."},"description":{"type":"string","description":"Give a description for the scheduled report export."},"external_report_object_identifier":{"type":"string","description":"Enter the unique identifier of the classic Insights report you want to export on a schedule. Each report has one. Use the Insights Report endpoint to get the identifier for the report you want to export."},"recurrence":{"type":"object","description":"A schedule for when you would like the report export to repeat, consisting of the `cadence` and `start_time` that you define.","properties":{"cadence":{"type":"string","description":"Define how often a scheduled export runs. Valid values: `hourly`, `daily`."},"start_time":{"type":"string","format":"date-time","description":"Define the date and time a schedule begins in ISO 8601 format. Daily scheduled exports will recur at this time everyday. This parameter is required for all non-hourly schedules. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}},"required":["cadence"]}}}}},"id":"schema_441"},"schema_442":{"kind":"json-schema","data":{"type":"object","properties":{"latest_success":{"type":"object","description":"Download the most recent successfully exported report.","properties":{"url":{"type":"string","description":"The URL to the most recent successful report export. Download the exported report within 60 seconds. The URL expiration period is subject to change. If you do not download the report within 60 seconds, you can send a new request to generate a new URL."},"created_at":{"type":"string","format":"date-time","description":"Timestamp for when the most recent successful report export was completed."}}}}},"id":"schema_442"},"schema_443":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string","description":"A unique identifier that each Insights report has. This identifier is primarily used by the Insights Report Exports endpoint to schedule exports of Insights reports."},"title":{"type":"string","description":"The title of an Insights report, defined by users."},"created_at":{"type":"string","format":"date-time","description":"The date and time a report was last updated."},"updated_at":{"type":"string","format":"date-time","description":"The date and time at which a report was created."}}}},"id":"schema_443"},"schema_444":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"client_invoice_defaults":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ClientInvoiceDefault"}}}},"id":"schema_444"},"schema_445":{"kind":"json-schema","data":{"type":"object","properties":{"client_invoice_default":{"type":"object","properties":{"client_account_id":{"type":"integer","format":"int32","description":"The user ID of the client being invoiced."},"time_rollup_type":{"type":"integer","format":"int32","description":"Options for how time is formatted on an invoice. These options include 'Detailed', 'Grouped by task',\nand 'Grouped by person, then task'. They are represented by the numbers 0, 1, and 2, respectively."},"expense_rollup_type":{"type":"integer","format":"int32","description":"Options for how expenses are formatted on an invoice. These options include 'Detailed' and 'Grouped'.\nThey are represented by the numbers 0 and 1, respectively."},"rich_text":{"type":"string","description":"The default rich text shown as additional details on the invoice."},"show_project_names":{"type":"integer","format":"int32","description":"Whether project names should be shown on the invoice."},"show_task_names":{"type":"boolean","description":"Whether task names should be shown for invoice items."},"show_subtotals":{"type":"boolean","description":"Whether subtotals should be shown for time entries on the invoice."},"show_creators":{"type":"boolean","description":"Whether the name of the person who created the entry should be shown."},"show_dates":{"type":"boolean","description":"Whether dates for items on the invoice should be shown."},"show_notes":{"type":"boolean","description":"Whether notes for items on the invoice should be shown."},"show_hours":{"type":"boolean","description":"Whether hours logged on a time entry on the invoice should be shown."},"show_rates":{"type":"boolean","description":"Whether the rate for the item should be shown."},"show_tax":{"type":"boolean","description":"Whether the item's taxable amount should be shown."},"show_roles":{"type":"boolean","description":"Whether the role of the person who created the item should be shown."}}}}},"id":"schema_445"},"schema_446":{"kind":"json-schema","data":{"type":"object","properties":{"client_invoice_default":{"type":"object","properties":{"time_rollup_type":{"type":"integer","format":"int32","description":"Options for how time is formatted on an invoice. These options include 'Detailed', 'Grouped by task', and 'Grouped by person, then task'. They are represented by the numbers 0, 1, and 2, respectively."},"expense_rollup_type":{"type":"integer","format":"int32","description":"Options for how expenses are formatted on an invoice. These options include 'Detailed' and 'Grouped', and are represented by the numbers 0 and 1, respectively."},"rich_text":{"type":"string","description":"The default rich text shown as additional details on the invoice."},"show_project_names":{"type":"integer","format":"int32","description":"Whether project names should be shown on the invoice."},"show_task_names":{"type":"boolean","description":"Whether task names should be shown for invoice items."},"show_subtotals":{"type":"boolean","description":"Whether subtotals should be shown for time entries on the invoice."},"show_creators":{"type":"boolean","description":"Whether the name of the person who created the entry should be shown."},"show_dates":{"type":"boolean","description":"Whether dates for items on the invoice should be shown."},"show_notes":{"type":"boolean","description":"Whether notes for items on the invoice should be shown."},"show_hours":{"type":"boolean","description":"Whether hours logged on a time entry on the invoice should be shown."},"show_rates":{"type":"boolean","description":"Whether the rate for the item should be shown."},"show_tax":{"type":"boolean","description":"Whether the item's taxable amount should be shown."},"show_roles":{"type":"boolean","description":"Whether the role of the person who created the item should be shown."}}}}},"id":"schema_446"},"schema_447":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"external_payments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalPayment"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"invoices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Invoice"}}}},"id":"schema_447"},"schema_448":{"kind":"json-schema","data":{"type":"object","properties":{"external_payment":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project in which the payment will be created."},"invoice_id":{"type":"integer","format":"int32","description":"The ID of the invoice (if any) that is being paid by the external payment. This automatically sets the amount\nattribute of the payment to the amount of the specified invoice, and will override any `amount_in_cents` parameter sent."},"amount_in_cents":{"type":"integer","format":"int32","description":"Indicates that the payment is not for an invoice, and will be ignored if an `invoice_id` is provided.\nMust be in base cent units of the currency of the project in which the payment is created."},"message":{"type":"string","description":"An optional string describing the payment (255 characters maximum)."}},"required":["workspace_id"]}}},"id":"schema_448"},"schema_449":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"invoices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Invoice"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"additional_items":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AdditionalItem"}},"time_entries":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TimeEntry"}},"expenses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Expense"}},"fixed_fee_items":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FixedFeeItem"}},"billing_milestones":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BillingMilestone"}}}},"id":"schema_449"},"schema_450":{"kind":"json-schema","data":{"type":"object","properties":{"invoice":{"type":"object","properties":{"time_entry_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"[Time Entry](/tag/Time-Entries) IDs. (At least one of the following is required: time_entry_ids, expense_ids, additional_items, fixed_fee_items, or billing_milestone_ids.)."},"expense_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"[Expense](/tag/Expenses) IDs. (At least one of the following is required: time_entry_ids, expense_ids, additional_items, fixed_fee_items, or billing_milestone_ids.)."},"fixed_fee_items":{"type":"array","description":"Fixed fee item objects to create (At least one of the following is required: time_entry_ids, expense_ids, additional_items, fixed_fee_items, or billing_milestone_ids.).","items":{"type":"object","properties":{"notes":{"type":"string","description":"Notes to display on the fixed fee item."},"amount":{"type":"integer","format":"int32","description":"The value of the fixed fee item, in the currency's main unit. Dollars, for example."},"taxable":{"type":"boolean","description":"Whether the fixed fee item is taxable."},"story_id":{"type":"integer","format":"int32","description":"The ID of the [Story](/tag/Stories) associated with the fixed fee item."},"workspace_id":{"type":"integer","format":"int32","description":"The ID of the [Workspace](/tag/Workspaces) associated with the fixed fee item."}}}},"additional_items":{"type":"array","description":"Additional item objects to create (At least one of the following is required: time_entry_ids, expense_ids, additional_items, fixed_fee_items, or billing_milestone_ids.).","items":{"type":"object","properties":{"notes":{"type":"string","description":"Notes to be displayed on the additional item."},"amount":{"type":"integer","format":"int32","description":"The value of the additional item, in the currency's main unit. Dollars, for example."},"taxable":{"type":"boolean","description":"Whether the additional item is taxable."},"workspace_id":{"type":"integer","format":"int32","description":"The ID of the [Workspace](/tag/Workspaces) associated with the additional item."}}}},"workspace_id":{"type":"integer","format":"int32","description":"The ID of the [Workspace](/tag/Workspaces) in which to create the invoice. (Either `workspace_id` or `workspace_ids` is required.)."},"workspace_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of the [Workspaces](/tag/Workspaces) in which to create the (multi-project) invoice. (Either `workspace_id` or `workspace_ids` is required.)."},"payment_schedule":{"type":"integer","format":"int32","description":"The number of days within which the total amount of the invoice is expected to be paid. For example, use `30` for a Net 30 payment schedule. See https://en.wikipedia.org/wiki/Net_D."},"invoice_date":{"type":"string","format":"date","description":"The invoice date. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"user_invoice_number":{"type":"integer","format":"int32","description":"The invoice number (defined by the user)."},"draft":{"type":"boolean","description":"Whether the invoice is a draft."},"message":{"type":"string","description":"Notes to be displayed on the invoice."},"user_invoice_title":{"type":"string","description":"The invoice title (defined by the user)."},"purchase_order":{"type":"string","description":"The invoice purchase order (defined by the user)."},"project_code":{"type":"string","description":"The invoice project code (defined by the user)."},"suppress_emails":{"type":"boolean","description":"Setting suppress_emails to true will prevent creation emails from being sent."},"billing_milestone_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of [billing milestones](/tag/Billing-Milestones) to add to the invoice. (At least one of the following is required: time_entry_ids, expense_ids, additional_items, fixed_fee_items, or billing_milestone_ids.)."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["payment_schedule"]}}},"id":"schema_450"},"schema_451":{"kind":"json-schema","data":{"type":"object","properties":{"next_invoice_number":{"type":"string","description":"The next invoice number."}}},"id":"schema_451"},"schema_452":{"kind":"json-schema","data":{"type":"object","properties":{"invoice":{"type":"object","properties":{"time_entry_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"An array of [Time Entry](/tag/Time-Entries) IDs. Setting this field updates the invoice's complete list of time entries; it behaves as an overwrite. Any time entries not included in your request will be removed from the invoice. Additionally, sending an empty array will remove all time entries from the invoice. At least one time entry, expense, fixed fee item, additional item, or billing milestone must be on the invoice."},"expense_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"An array of [Expense](/tag/Expenses) IDs. Setting this field updates the invoice's complete list of expenses; it behaves as an overwrite. Any expenses not included in your request will be removed from the invoice. Additionally, sending an empty array will remove all expenses from the invoice. At least one time entry, expense, fee item, additional item, or billing milestone must be on the invoice."},"payment_schedule":{"type":"integer","format":"int32","description":"The number of days within which the total amount of the invoice is expected to be paid. For example, use `30` for a Net 30 payment schedule. See https://en.wikipedia.org/wiki/Net_D."},"invoice_date":{"type":"string","format":"date","description":"The invoice date. Determines the date from which the payment schedule will start. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"user_invoice_number":{"type":"integer","format":"int32","description":"The invoice number (defined by the user)."},"draft":{"type":"boolean","description":"Whether the invoice is a draft."},"message":{"type":"string","description":"Notes to be displayed on the invoice."},"user_invoice_title":{"type":"string","description":"The invoice title (defined by the user)."},"purchase_order":{"type":"string","description":"The invoice purchase order (defined by the user)."},"project_code":{"type":"string","description":"The invoice project code (defined by the user)."},"billing_milestone_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of [billing milestones](/tag/Billing-Milestones) to add to the invoice. Setting this field updates the invoice's complete list of billing milestones; it behaves as an overwrite. Any billing milestones not included in your request will be removed from the invoice. Additionally, sending an empty array will remove all billing milestones from the invoice. At least one time entry, expense, fixed fee item, additional item, or billing milestone must be on the invoice."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_452"},"schema_453":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_invoice_preference":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project for which the invoice preferences will apply."},"purchase_order":{"type":"string","description":"The invoice purchase order (defined by the user)."},"project_code":{"type":"string","description":"The invoice project code (defined by the user)."},"client_invoice_name":{"type":"string","description":"The name of the client being invoiced."},"client_invoice_address":{"type":"string","description":"The address of the client being invoiced."},"consultant_invoice_name":{"type":"string","description":"The name of the provider who is sending the invoice."},"consultant_invoice_address":{"type":"string","description":"The address of the provider who is sending the invoice."}},"required":["workspace_id"]}}},"id":"schema_453"},"schema_454":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"workspace_invoice_preferences":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceInvoicePreference"}}}},"id":"schema_454"},"schema_455":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_invoice_preference":{"type":"object","properties":{"purchase_order":{"type":"string","description":"The invoice purchase order (defined by the user)."},"project_code":{"type":"string","description":"The invoice project code (defined by the user)."},"client_invoice_name":{"type":"string","description":"The name of the client being invoiced."},"client_invoice_address":{"type":"string","description":"The address of the client being invoiced."},"consultant_invoice_name":{"type":"string","description":"The name of the provider who is sending the invoice."},"consultant_invoice_address":{"type":"string","description":"The address of the provider who is sending the invoice."}}}}},"id":"schema_455"},"schema_456":{"kind":"json-schema","data":{"type":"string","default":"newest_reply_at:desc"},"id":"schema_456"},"schema_457":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"posts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Post"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"attachments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Attachments_PostAttachment"}}}},"id":"schema_457"},"schema_458":{"kind":"json-schema","data":{"type":"object","properties":{"post":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project in which the post will be created."},"message":{"type":"string","description":"The content created in the new post."},"subject_id":{"type":"integer","format":"int32","description":"The ID of the item to which the new post is replying (only `required` for replies)."},"subject_type":{"type":"string","description":"The type of item to which the new post is replying (only `required` for replies). Accepted values are `Post`."},"story_id":{"type":"integer","format":"int32","description":"The ID of the task to which the new post should be linked."},"recipient_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"An array of User IDs for which the post is visible. These users must be participating in the target\nproject. Including this parameter will make the post private."},"attachment_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"An array of PostAttachment IDs to be associated with the post. Create PostAttachments using\nthe attachments endpoint."},"google_documents":{"type":"array","description":"An array of Google document to be associated with the post.","items":{"type":"object","properties":{"resource_id":{"type":"string","description":"A unique identifier for the Google document."},"access":{"type":"string","description":"Allowed access to the Google document."}}}},"backdated_to":{"type":"string","format":"date-time","description":"Backdates the post creation date on imports. Defaults to *Now*. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}},"required":["workspace_id","message"]}}},"id":"schema_458"},"schema_459":{"kind":"json-schema","data":{"type":"object","properties":{"post":{"type":"object","properties":{"message":{"type":"string","description":"The message content of the post."},"story_id":{"type":"integer","format":"int32","description":"The ID of the task that is linked to the post."}}}}},"id":"schema_459"},"schema_460":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"user_file_associations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/UserFileAssociation"}},"posts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Post"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}}}},"id":"schema_460"},"schema_461":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"project_snapshots":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Project_Snapshots_Models_ProjectSnapshot"}},"project_snapshot_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Project_Snapshots_Models_ProjectSnapshotResource"}},"project_snapshot_tasks":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Project_Snapshots_Models_ProjectSnapshotTask"}},"project_snapshot_custom_field_values":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Project_Snapshots_Models_ProjectSnapshotCustomFieldValue"}},"project_snapshot_assignments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Project_Snapshots_Models_ProjectSnapshotAssignment"}}}},"id":"schema_461"},"schema_462":{"kind":"json-schema","data":{"type":"object","properties":{"project_snapshot":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the workspace to take a snapshot of."},"title":{"type":"string","description":"The title of the snapshot."},"description":{"type":"string","description":"The description of the snapshot."},"replace_baseline":{"type":"boolean","description":"Whether the snapshot should be set as the workspace's baseline."}},"required":["workspace_id"]}}},"id":"schema_462"},"schema_463":{"kind":"json-schema","data":{"type":"object","properties":{"project_snapshot":{"type":"object","properties":{"title":{"type":"string","description":"The title of the snapshot."},"description":{"type":"string","description":"The description of the snapshot."},"replace_baseline":{"type":"boolean","description":"Whether the snapshot should be set as the workspace's baseline."}}}}},"id":"schema_463"},"schema_464":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"project_template_additional_tabs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProjectTemplateAdditionalTab"}}}},"id":"schema_464"},"schema_465":{"kind":"json-schema","data":{"type":"object","properties":{"project_template_additional_tab":{"type":"object","properties":{"project_template_id":{"type":"integer","format":"int32","description":"The ID of the template to add the additional tab to."},"tab_type":{"type":"string","description":"The type of the additional tab. Options are `form` and `dashboard` (i.e. an Insights dynamic dashboard)."},"associated_tab_id":{"type":"integer","format":"int32","description":"The ID of the form or dynamic dashboard."}},"required":["project_template_id","tab_type","associated_tab_id"]}}},"id":"schema_465"},"schema_466":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["total_estimated_minutes","total_count","role_initials","role_name"]}},"id":"schema_466"},"schema_467":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"project_template_assignments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProjectTemplateAssignment"}},"project_templates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProjectTemplate"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}}}},"id":"schema_467"},"schema_468":{"kind":"json-schema","data":{"type":"object","properties":{"project_template_assignment":{"type":"object","properties":{"name":{"type":"string","description":"The name of resource or assignment placeholder for the associated project template."},"project_template_id":{"type":"integer","format":"int32","description":"The ID of the associated project template."}},"required":["name","project_template_id"]}}},"id":"schema_468"},"schema_469":{"kind":"json-schema","data":{"type":"object","properties":{"project_template_assignment":{"type":"object","properties":{"name":{"type":"string","description":"The name of resource or assignment placeholder for the associated project template."}},"required":["name"]}}},"id":"schema_469"},"schema_470":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"project_template_expense_budgets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProjectTemplateExpenseBudget"}},"project_templates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProjectTemplate"}}}},"id":"schema_470"},"schema_471":{"kind":"json-schema","data":{"type":"object","properties":{"project_template_expense_budget":{"type":"object","properties":{"project_template_id":{"type":"integer","format":"int32","description":"The ID of the template to add the expense budget to."},"title":{"type":"string","description":"The name of the expense budget."},"description":{"type":"string","description":"The description of the expense budget."},"billable":{"type":"boolean","description":"Whether the expense will be billed to the client."},"burns_budget":{"type":"boolean","description":"Whether the expense budget impacts the project margin."},"fixed_fee":{"type":"boolean","description":"Whether the expense will be billed as a fixed cost."},"cost_per_unit_in_subunits":{"type":"integer","format":"int32","description":"The cost, in the subunits of the currency (e.g. cents for USD)."},"markup_type":{"type":"string","description":"The markup type. Possible values are `percentage` and `flat_fee`."},"markup_per_unit_in_subunits":{"type":"integer","format":"int32","description":"The markup per unit, in the subunits of the currency (e.g. cents for USD)."},"markup_percentage":{"type":"number","format":"float","description":"If the `markup_type` is `percentage`, this is the markup percentage to apply to the expenses."},"quantity":{"type":"integer","format":"int32","description":"The number of expected units for the expense budget."},"relative_expected_by_date":{"type":"integer","format":"int32","description":"When the expenses are expected to be logged, relative to the project’s start date.\nYou can provide a negative value to indicate expenses are expected before the\nproject’s start date."}},"required":["project_template_id","title","billable","burns_budget","fixed_fee"]}}},"id":"schema_471"},"schema_472":{"kind":"json-schema","data":{"type":"object","properties":{"project_template_expense_budget":{"type":"object","properties":{"title":{"type":"string","description":"The name of the expense budget."},"billable":{"type":"boolean","description":"Whether the expense will be billed to the client."},"burns_budget":{"type":"boolean","description":"Whether the expense budget impacts the project margin."},"fixed_fee":{"type":"boolean","description":"Whether the expense will be billed as a fixed cost."},"description":{"type":"string","description":"The description of the expense budget."},"cost_per_unit_in_subunits":{"type":"integer","format":"int32","description":"The cost, in the subunits of the currency (e.g. cents for USD)."},"markup_type":{"type":"string","description":"The markup type. Possible values are `percentage` and `flat_fee`."},"markup_per_unit_in_subunits":{"type":"integer","format":"int32","description":"The markup per unit, in the subunits of the currency (e.g. cents for USD)."},"markup_percentage":{"type":"number","format":"float","description":"If the `markup_type` is `percentage`, this is the markup percentage to apply to the expenses."},"quantity":{"type":"integer","format":"int32","description":"The number of expected units for the expense budget."},"relative_expected_by_date":{"type":"integer","format":"int32","description":"When the expenses are expected to be logged, relative to the project’s start date.\nYou can provide a negative value to indicate expenses are expected before the\nproject’s start date."}}}}},"id":"schema_472"},"schema_473":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["raw_json"]}},"id":"schema_473"},"schema_474":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"project_templates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProjectTemplate"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"project_template_assignments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProjectTemplateAssignment"}},"project_template_additional_tabs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProjectTemplateAdditionalTab"}}}},"id":"schema_474"},"schema_475":{"kind":"json-schema","data":{"type":"object","properties":{"project_template":{"type":"object","properties":{"title":{"type":"string","description":"The title of the project template."},"sharing":{"type":"string","description":"The sharing setting for the template. Viewable and editable templates can be seen by users on the account other than the creator.","enum":["private_template","viewable_template","editable_template"]},"is_budgeted":{"type":"boolean","description":"The project template has financial attributes including overall budget, task budgets, and task time estimates."},"budget":{"type":"integer","format":"int32","description":"The estimated overall budget of the project associated with the template."},"duration":{"type":"integer","format":"int32","description":"The estimated number of days that the associated project will take."},"currency":{"type":"string","description":"The currency of the project template."},"description":{"type":"string","description":"A description of the project template which does not carry over to the project description when applied."},"raw_json":{"type":"string","description":"A JSON hash that contains all project templates' tasks."}},"required":["title","currency"]}}},"id":"schema_475"},"schema_476":{"kind":"json-schema","data":{"type":"object","properties":{"project_template":{"type":"object","properties":{"title":{"type":"string","description":"The title of the project template."},"sharing":{"type":"string","description":"The sharing setting for the template. Viewable and editable templates can be seen by users on the account other than the creator.","enum":["private_template","viewable_template","editable_template"]},"is_budgeted":{"type":"boolean","description":"The project template has financial attributes including overall budget, task budgets, and task time estimates."},"budget":{"type":"integer","format":"int32","description":"The estimated overall budget of the project associated with the template."},"duration":{"type":"integer","format":"int32","description":"The estimated number of days that the associated project will take to complete."},"currency":{"type":"string","description":"The currency of the project template."},"description":{"type":"string","description":"A description of the project template which does not carry over to the project description when applied."},"raw_json":{"type":"string","description":"A JSON hash that contains all project templates' tasks."}},"required":["title"]}}},"id":"schema_476"},"schema_477":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["access_level","is_foreign_participant","can_schedule_their_hours","can_schedule_team_hours","permissions_label"]}},"id":"schema_477"},"schema_478":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"participations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Participation"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}},"workspace_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceResource"}}}},"id":"schema_478"},"schema_479":{"kind":"json-schema","data":{"type":"object","properties":{"participation":{"type":"object","properties":{"can_invite":{"type":"boolean","description":"Permission for the participant to invite other users into the project."},"can_schedule_their_hours":{"type":"boolean","description":"Permission for the participant to schedule their own hours."},"can_schedule_team_hours":{"type":"boolean","description":"Permission for the participant to schedule hours for project team members."},"can_edit_todos":{"type":"boolean","description":"Permission for the participant to edit To Dos."},"access_level":{"type":"string","description":"Access level for the user in the workspace. Valid options include \"edit_tasks\", \"view_tasks\", \"edit_time_and_expenses\", \"view_time_and_expenses\",\n\"edit_financials\", \"view_financials\", \"admin\". Legacy options include \"financial\", \"time_logging\", \"collaboration\"."},"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project the participation will belong to."},"role":{"type":"string","description":"The team a participant is on in a project, defined as either the \"maven\" (provider) or \"buyer\" (client) team."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user that wants to participate in the project."},"permissions":{"type":"string","description":"Permission for the user in the workspace. It must be any combination of \"edit\", \"view_only\", \"view_and_post\",\n\"can_edit\", \"can_post\", \"can_edit_expense\", \"can_edit_time\", \"can_invite\", \"can_schedule_their_hours\", or\n\"can_schedule_team_hours\" delimited by commas. ex. \"can_post,can_edit_time\"\n\nIf \"can_invite\", \"can_schedule_their_hours\", or \"can_schedule_team_hours\" are not set—either via the individual\nfields or the `permissions` string—they will inherit the default values defined in the account's Project Permissions Defaults."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["workspace_id","role"]}}},"id":"schema_479"},"schema_480":{"kind":"json-schema","data":{"type":"object","properties":{"participation":{"type":"object","properties":{"can_invite":{"type":"boolean","description":"Permission for the participant to invite other users into the project."},"can_schedule_their_hours":{"type":"boolean","description":"Permission for the participant to schedule their own hours."},"can_schedule_team_hours":{"type":"boolean","description":"Permission for the participant to schedule hours for project team members."},"can_edit_todos":{"type":"boolean","description":"Permission for the participant to edit To Dos."},"access_level":{"type":"string","description":"Access level for the user in the workspace. Valid options include \"edit_tasks\", \"view_tasks\", \"edit_time_and_expenses\", \"view_time_and_expenses\",\n\"edit_financials\", \"view_financials\", \"admin\". Legacy options include \"financial\", \"time_logging\", \"collaboration\"."},"team_lead":{"type":"boolean","description":"Update the role of the participant to be the team lead of the project."},"cost_in_cents":{"type":"integer","format":"int32","description":"Update the cost rate in cents per hour for the participant."},"rate_in_cents":{"type":"integer","format":"int32","description":"Update the bill rate in cents per hour for the participant.\nThis bill rate is ignored if Rate cards are enabled on the account."},"workspace_role_id":{"type":"integer","format":"int32","description":"The ID of the participant's assigned role on a project."},"permissions":{"type":"string","description":"Permission for the user in the workspace. It must be any combination of \"edit\", \"view_only\", \"view_and_post\",\n\"can_edit\", \"can_post\", \"can_edit_expense\", \"can_edit_time\", \"can_invite\", \"can_schedule_their_hours\", or\n\"can_schedule_team_hours\" delimited by commas. ex. \"can_post,can_edit_time\"."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_480"},"schema_481":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_481"},"schema_482":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"project_accounting_records":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProjectAccounting_Models_ProjectAccountingRecord"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}}}},"id":"schema_482"},"schema_483":{"kind":"json-schema","data":{"type":"object","properties":{"project_accounting_record":{"type":"object","description":"A single project accounting record and its attributes.","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project the record belongs to."},"start_date":{"type":"string","format":"date","description":"The date the accounting period begins,\n in ISO8601 format (e.g. `2014-06-25`). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"end_date":{"type":"string","format":"date","description":"The date the accounting period ends,\n in ISO8601 format (e.g. `2014-02-25`). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"currency":{"type":"string","description":"The currency of the record. Valid values are\n [ISO codes of currencies supported by Kantata OX](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473)."},"type":{"type":"string","description":"The type of project accounting record:\n* `Baseline`\n* `Earned Value`\n* `Earned Value Forecasting`\n* `Forecasting`\n* `Recognition` (Default)\n\nIf not specified, a `Recognition` record is created by default.\n\n**Note:** Make sure to include the spaces in `Earned Value` and `Earned Value Forecasting`\nwhen making a request."},"amount":{"type":"number","format":"float","description":"The amount being calculated for baseline, forecasting,\n earned value, earned value forecasting, or revenue recognition within the specified accounting period,\n up to 2 decimal places (e.g. 575.75).\n Values can also be negative (e.g. -96.75)."},"amount_to_date":{"type":"number","format":"float","description":"The total amount spent to date\n (for all accounting periods), up to 2 decimal places (e.g. 1252.33).\n Values can also be negative (e.g. -83.33)."},"budget":{"type":"number","format":"float","description":"The budget of the project or task,\n up to 2 decimal places (e.g. 2457.52). Values can also be negative (e.g. -350.52)."},"contract_date":{"type":"string","format":"date","description":"This can be a contract's start or end date in ISO8601 format,\n or any other date a user prefers. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"cost":{"type":"number","format":"float","description":"The cost of the project or task within the specified accounting period,\n up to 2 decimal places (e.g. 3003.56). Values can also be negative (e.g. -350.72)."},"cost_eac":{"type":"number","format":"float","description":"The\n [estimated cost](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n of the project or task when it is completed, up to 2 decimal places (e.g. 8326.55).\n Values can also be negative (e.g. -426.55).\n This updates during the course of a project or task, as costs are logged."},"description":{"type":"string","description":"This can be a brief description of the record,\n or anything a user prefers."},"fees":{"type":"number","format":"float","description":"The fees from the specified accounting period,\n up to 2 decimal places (e.g. 324.53). Values can also be negative (e.g. -41.53)."},"hours":{"type":"number","format":"float","description":"The [hours](https://mavenlink.zendesk.com/hc/en-us/articles/360059325413)\n spent within the specified accounting period, up to 2 decimal places (e.g. 23.25).\n Values can also be negative (e.g. -7.25)."},"hours_eac":{"type":"number","format":"float","description":"The\n [estimated hours](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n for the project or task when it is completed, up to 2 decimal places (e.g. 82.25).\n Values can also be negative (e.g. -22.25).\n This updates during the course of a project or task, as hours are logged."},"hours_etc":{"type":"number","format":"float","description":"The\n [estimated hours](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n until completion (`hours_eac` - `hours`) of the project or task, up to two decimal places (e.g. 53.25).\n Values can also be negative (e.g. -10.25)."},"total_estimated_hours":{"type":"number","format":"float","description":"The hours initially estimated for the project or task,\n up to 2 decimal places (e.g. 83.50). Values can also be negative (e.g. -12.25).\n This value does not change over the course of a project."},"total_hours_to_date":{"type":"number","format":"float","description":"The total hours logged to date for the project or task,\n up to 2 decimal places (e.g. 32.25). Values can also be negative (e.g. -5.75)."},"labor_type":{"type":"string","description":"The type of cost associated with the record.\n Valid values are `Labor` or `Non-Labor`."},"notes":{"type":"string","description":"This can be any extra information to note about the record."},"percent_complete":{"type":"number","format":"float","description":"How much of the project or task is complete\n in decimal format, up to 2 places (e.g. 0.75). Values can also be negative (e.g. -.25)."},"role_id":{"type":"integer","format":"int32","description":"The ID of the role associated with the record."},"service_type":{"type":"string","description":"This can be an organization-specific category of services\n that is related to the record (e.g. Branding, Campaigns, Photography, etc.)."},"status":{"type":"string","description":"The status of the record.\n Valid values: `Draft`, `Pending Approval`, `Approved`, `Cancelled`."},"story_id":{"type":"integer","format":"int32","description":"The ID of the task related to the record."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user associated with the record\n (e.g. who created the record, who the record was created for, etc.)."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["workspace_id","start_date","end_date","currency"]},"project_accounting_records":{"type":"array","description":"Multiple project accounting records and their attributes in an array.","items":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project the record belongs to."},"start_date":{"type":"string","format":"date","description":"The date the accounting period begins,\n in ISO8601 format (e.g. `2014-06-25`). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"end_date":{"type":"string","format":"date","description":"The date the accounting period ends,\n in ISO8601 format (e.g. `2014-02-25`). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"currency":{"type":"string","description":"The currency of the record. Valid values are\n [ISO codes of currencies supported by Kantata OX](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473)."},"type":{"type":"string","description":"The type of project accounting record:\n* `Baseline`\n* `Earned Value`\n* `Earned Value Forecasting`\n* `Forecasting`\n* `Recognition` (Default)\n\nIf not specified, a `Recognition` record is created by default.\n\n**Note:** Make sure to include the spaces in `Earned Value` and `Earned Value Forecasting`\nwhen making a request."},"amount":{"type":"number","format":"float","description":"The amount being calculated for baseline, forecasting,\n earned value, earned value forecasting, or revenue recognition within the specified accounting period,\n up to 2 decimal places (e.g. 575.75).\n Values can also be negative (e.g. -96.75)."},"amount_to_date":{"type":"number","format":"float","description":"The total amount spent to date\n (for all accounting periods), up to 2 decimal places (e.g. 1252.33).\n Values can also be negative (e.g. -83.33)."},"budget":{"type":"number","format":"float","description":"The budget of the project or task,\n up to 2 decimal places (e.g. 2457.52). Values can also be negative (e.g. -350.52)."},"contract_date":{"type":"string","format":"date","description":"This can be a contract's start or end date in ISO8601 format,\n or any other date a user prefers. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"cost":{"type":"number","format":"float","description":"The cost of the project or task within the specified accounting period,\n up to 2 decimal places (e.g. 3003.56). Values can also be negative (e.g. -350.72)."},"cost_eac":{"type":"number","format":"float","description":"The\n [estimated cost](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n of the project or task when it is completed, up to 2 decimal places (e.g. 8326.55).\n Values can also be negative (e.g. -426.55).\n This updates during the course of a project or task, as costs are logged."},"description":{"type":"string","description":"This can be a brief description of the record,\n or anything a user prefers."},"fees":{"type":"number","format":"float","description":"The fees from the specified accounting period,\n up to 2 decimal places (e.g. 324.53). Values can also be negative (e.g. -41.53)."},"hours":{"type":"number","format":"float","description":"The [hours](https://mavenlink.zendesk.com/hc/en-us/articles/360059325413)\n spent within the specified accounting period, up to 2 decimal places (e.g. 23.25).\n Values can also be negative (e.g. -7.25)."},"hours_eac":{"type":"number","format":"float","description":"The\n [estimated hours](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n for the project or task when it is completed, up to 2 decimal places (e.g. 82.25).\n Values can also be negative (e.g. -22.25).\n This updates during the course of a project or task, as hours are logged."},"hours_etc":{"type":"number","format":"float","description":"The\n [estimated hours](https://mavenlink.zendesk.com/hc/en-us/articles/360004619334-Project-Completion-Estimates)\n until completion (`hours_eac` - `hours`) of the project or task, up to two decimal places (e.g. 53.25).\n Values can also be negative (e.g. -10.25)."},"total_estimated_hours":{"type":"number","format":"float","description":"The hours initially estimated for the project or task,\n up to 2 decimal places (e.g. 83.50). Values can also be negative (e.g. -12.25).\n This value does not change over the course of a project."},"total_hours_to_date":{"type":"number","format":"float","description":"The total hours logged to date for the project or task,\n up to 2 decimal places (e.g. 32.25). Values can also be negative (e.g. -5.75)."},"labor_type":{"type":"string","description":"The type of cost associated with the record.\n Valid values are `Labor` or `Non-Labor`."},"notes":{"type":"string","description":"This can be any extra information to note about the record."},"percent_complete":{"type":"number","format":"float","description":"How much of the project or task is complete\n in decimal format, up to 2 places (e.g. 0.75). Values can also be negative (e.g. -.25)."},"role_id":{"type":"integer","format":"int32","description":"The ID of the role associated with the record."},"service_type":{"type":"string","description":"This can be an organization-specific category of services\n that is related to the record (e.g. Branding, Campaigns, Photography, etc.)."},"status":{"type":"string","description":"The status of the record.\n Valid values: `Draft`, `Pending Approval`, `Approved`, `Cancelled`."},"story_id":{"type":"integer","format":"int32","description":"The ID of the task related to the record."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user associated with the record\n (e.g. who created the record, who the record was created for, etc.)."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["workspace_id","start_date","end_date","currency"]}}}},"id":"schema_483"},"schema_484":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"status_reports":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StatusReport"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}}}},"id":"schema_484"},"schema_485":{"kind":"json-schema","data":{"type":"object","properties":{"status_report":{"type":"object","properties":{"workspace_id":{"type":"string","description":"The ID of the project to create the status report for."},"color":{"type":"string","description":"The status color of the overall report. Valid values: green, yellow, red."},"description":{"type":"string","description":"The description of the overall status of the project."},"details":{"type":"array","description":"An array of optional category statuses to report on specific aspects of a project.","items":{"type":"object","properties":{"category":{"type":"string","description":"The category for which this detail applies. Valid values: Scope, Budget, Schedule, Client."},"color":{"type":"string","description":"The status color for the specified category. Valid values: green, yellow, red."},"description":{"type":"string","description":"A description of the status of the specified category."}},"required":["category","color"]}},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["workspace_id","color","description"]}}},"id":"schema_485"},"schema_486":{"kind":"json-schema","data":{"type":"object","properties":{"status_report":{"type":"object","properties":{"color":{"type":"string","description":"The status color for for the report overall. One of green, yellow, red."},"description":{"type":"string","description":"The description of the overall status of the project."},"details":{"type":"array","description":"An array of optional category statuses to report on specific aspects of a project. Any\ncategories not provided when updating will be deleted if they were previously present.","items":{"type":"object","properties":{"category":{"type":"string","description":"The category for which this detail applies. One of Scope, Budget, Schedule, Client."},"color":{"type":"string","description":"The status color for the specified category. One of green, yellow, red."},"description":{"type":"string","description":"A description of the status of the specified category."}},"required":["category","color"]}},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_486"},"schema_487":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"workspace_allocations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceAllocation"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"workspace_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceResource"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}}}},"id":"schema_487"},"schema_488":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_allocation":{"type":"object","properties":{"resource_id":{"type":"integer","format":"int32","description":"The id of the workspace resource that the allocation will be associated with."},"start_date":{"type":"string","format":"date","description":"The date the allocation starts on. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"end_date":{"type":"string","format":"date","description":"The date the allocation ends on. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"minutes":{"type":"integer","format":"int32","description":"Total minutes the resource is allocated over the date range."},"hard":{"type":"boolean","description":"Indicates if the allocation is a Hard Allocation (“true”) or Soft (“false”)."},"notes":{"type":"string","description":"User entered notes about the allocation."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["resource_id","start_date","end_date","minutes"]}}},"id":"schema_488"},"schema_489":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_allocation":{"type":"object","properties":{"start_date":{"type":"string","format":"date","description":"The date the allocation starts on. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"end_date":{"type":"string","format":"date","description":"The date the allocation ends on. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"minutes":{"type":"integer","format":"int32","description":"Total minutes the resource is allocated over the date range."},"hard":{"type":"boolean","description":"Indicates if the allocation is a Hard Allocation (“true”) or Soft (“false”)."},"notes":{"type":"string","description":"User entered notes about the allocation."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_489"},"schema_490":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"workspace_baselines":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceBaseline"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"baseline_payloads":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BaselinePayload"}}}},"id":"schema_490"},"schema_491":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_baseline":{"type":"object","properties":{"title":{"type":"string","description":"The title of the workspace baseline."},"description":{"type":"string","description":"The description of the workspace baseline."},"workspace_id":{"type":"integer","format":"int32","description":"The ID of the workspace the workspace baseline will belong to."}},"required":["title"]}}},"id":"schema_491"},"schema_492":{"kind":"json-schema","data":{"type":"string","default":"name:ASC"},"id":"schema_492"},"schema_493":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"workspace_groups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceGroup"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"rate_card_sets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardSet"}}}},"id":"schema_493"},"schema_494":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_group":{"type":"object","properties":{"name":{"type":"string","description":"The name of the new workspace group. Names must be unique and are not case sensitive. (ie: an account cannot both have a workspace group named \"Kantata\" and another named \"kantata\")."},"add_workspace_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of the workspaces to add to this group. The authorizing user must have access to all specified workspaces."},"notes":{"type":"string","description":"Notes on the group."},"company":{"type":"boolean","description":"Whether the group represents a company."},"contact_name":{"type":"string","description":"The name of the company contact."},"email":{"type":"string","description":"The email of the company contact."},"phone_number":{"type":"string","description":"The phone number of the company contact."},"address":{"type":"string","description":"The address of the company contact."},"website":{"type":"string","description":"The website of the company contact."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["name"]}}},"id":"schema_494"},"schema_495":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_group":{"type":"object","properties":{"name":{"type":"string","description":"The name of the group."},"add_workspace_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of the workspaces to add to this group. Workspaces already associated with the workspace group will retain association. The authorizing user must have access to all the specified workspaces."},"remove_workspace_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of the workspaces to remove from this group. The authorizing user must have access to all specified workspaces."},"notes":{"type":"string","description":"Notes on the group."},"company":{"type":"boolean","description":"Whether the group represents a company."},"contact_name":{"type":"string","description":"The name of the company contact."},"email":{"type":"string","description":"The email of the company contact."},"phone_number":{"type":"string","description":"The phone number of the company contact."},"address":{"type":"string","description":"The address of the company contact."},"website":{"type":"string","description":"The website of the company contact."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["name"]}}},"id":"schema_495"},"schema_496":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"workspace_resource_skills":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceResourceSkill"}},"skills":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Skill"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workspace_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceResource"}}}},"id":"schema_496"},"schema_497":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_resource_skill":{"type":"object","properties":{"skill_id":{"type":"integer","format":"int32","description":"The ID of the skill."},"workspace_resource_id":{"type":"integer","format":"int32","description":"The ID of the workspace resource."},"level":{"type":"integer","format":"int32","description":"The workspace resource's proficiency level in the skill (1-5). This defaults to 1 if it is not specified.\nNote: Not all skills have levels."}},"required":["skill_id","workspace_resource_id"]}}},"id":"schema_497"},"schema_498":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_resource_skill":{"type":"object","properties":{"level":{"type":"integer","format":"int32","description":"The workspace resource's proficiency level in the skill (1-5). This defaults to 0 if it is not specified.\nNote: Not all skills have levels."}}}}},"id":"schema_498"},"schema_499":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["resource_bill_rate","resource_cost_rate"]}},"id":"schema_499"},"schema_500":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"workspace_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceResource"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}},"organization_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/OrganizationMembership"}},"participations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Participation"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"custom_field_values":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldValue"}}}},"id":"schema_500"},"schema_501":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_resource":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The workspace ID associated with this resource."},"user_id":{"type":"integer","format":"int32","description":"The user ID associated with this resource. A null value indicates that this is an unnamed resource."},"role_id":{"type":"integer","format":"int32","description":"The role ID associated with this resource. The role ID is a required attribute to create unnamed\nresources. This defaults to the user's primary project role if the user is specified."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["workspace_id"]}}},"id":"schema_501"},"schema_502":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","description":"An array of objects representing allocations to create for the specified resources.","items":{"type":"object","properties":{"resource_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"An array of IDs of the resources to create allocations for. NOTE: This is only applicable when updating multiple resources via\n `workspace_resources/allocations_matching_scheduled_hours`."},"hard":{"type":"boolean","description":"Whether the allocation is a Hard Allocation (“true”) or Soft (“false”). This value must be set to `false` if you are including any unnamed resources in your request."},"occurrence":{"type":"object","description":"The timeframe of scheduled hours in which to create allocations for.","properties":{"type":{"type":"string","description":"The timeframe in which to allocate the scheduled hours. Accepted values are `anytime`, `after`, `before`, and `between`.","enum":["anytime","after","before","between"]},"after_date":{"type":"string","format":"date-time","description":"Sets the date on and after which the scheduled hours will be distributed as allocations. This value must be provided when the `type` is `after`. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"before_date":{"type":"string","format":"date-time","description":"Sets the date on and before which the scheduled hours will be distributed as allocations. This value must be provided when the `type` is `before`. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"start_date":{"type":"string","format":"date-time","description":"Sets the start of the date range which the scheduled hours will be distributed as allocations. This value must be provided when the `type` is `between`. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"end_date":{"type":"string","format":"date-time","description":"Sets the end of the date range which the scheduled hours will be distributed as allocations. This value must be provided when the `type` is `between`. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}},"required":["type"]}},"required":["resource_ids","hard","occurrence"]}}}},"id":"schema_502"},"schema_503":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates if workspace allocations were created."}}},"id":"schema_503"},"schema_504":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_resource":{"type":"object","properties":{"label":{"type":"string","description":"A unique label that is automatically generated for a resource when it is created. Default resource labels in Kantata OX are based on role name and numerical order, but can be renamed by you."},"user_id":{"type":"integer","format":"int32","description":"The user ID associated with this resource."},"role_id":{"type":"integer","format":"int32","description":"The role ID associated with this resource. The role ID is a required attribute for unnamed resources."},"auto_update_label":{"type":"boolean","description":"If true, automatically updates resource labels to match roles associated with updated role IDs when labels are not provided. When a label is provided, that overrides this setting."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_504"},"schema_505":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"workspace_status_changes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceStatusChange"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}}}},"id":"schema_505"},"schema_506":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_status_change":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project that contains the project status change."},"to_status_key":{"type":"integer","format":"int32","description":"The status key for the new project status. See the [Knowledge Base](https://knowledge.kantata.com/hc/en-us/articles/115005042433#Project-Status-List) for a list of project status IDs. Note that setting a project's status to its current status will result in an error. To avoid this, you can use the [update workspace](/tag/Workspaces#operation/update-workspace) endpoint and its `status_key` parameter instead."}},"required":["workspace_id","to_status_key"]}}},"id":"schema_506"},"schema_507":{"kind":"json-schema","data":{"type":"object","properties":{"workspace_task_status_sets":{"type":"array","description":"A list of workspaces to update task status sets for.","items":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the workspace to update."},"status_set_id":{"type":"integer","format":"int32","description":"The ID of the task status set to assign to the workspace."}},"required":["workspace_id","status_set_id"]}}}},"id":"schema_507"},"schema_508":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"workspace_task_status_sets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceStatusSet"}}}},"id":"schema_508"},"schema_509":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["revenue_recognition_method_id","revenue_recognition_method_name","client_lead_name","provider_lead_name","stage","estimated_minutes","total_invoiced","total_minutes_approved","billable_minutes","non_billable_minutes","minutes_logged","incoming_email_address","lock_date"]}},"id":"schema_509"},"schema_510":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"participations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Participation"}},"timesheet_submissions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TimesheetSubmission"}},"workspace_groups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceGroup"}},"custom_field_values":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldValue"}},"workspace_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceResource"}},"status_reports":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StatusReport"}},"account_colors":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountColor"}},"account_insights_mappings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AccountInsightsMapping"}},"billing_milestones":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BillingMilestone"}}}},"id":"schema_510"},"schema_511":{"kind":"json-schema","data":{"type":"object","properties":{"workspace":{"type":"object","properties":{"consultant_role_name":{"type":"string","description":"The label for the consultant team (i.e. the team providing the service)."},"client_role_name":{"type":"string","description":"The label for the client team (i.e. the team paying for the service)."},"budgeted":{"type":"boolean","description":"Whether the project is budgeted.\nDefaults to `true` for paid accounts.\nDefaults to `false` for free accounts."},"start_date":{"type":"string","format":"date","description":"When the project starts. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"due_date":{"type":"string","format":"date","description":"When the project is due. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"description":{"type":"string","description":"The description of the project."},"currency":{"type":"string","description":"The currency of the project.\nOnly applicable if `budgeted` is true.\nSee the [Knowledge Base](https://knowledge.kantata.com/hc/en-us/articles/360041576473) for the list of currency codes.\nDefaults to the account currency or `USD`.\nIf a `rate_card_id` is provided, this field is ignored."},"access_level":{"type":"string","description":"Whether the project is open, and who can join the project.","enum":["invitation","open","admins"]},"rate_card_id":{"type":"integer","format":"int32","description":"The ID of the rate card for the project. The currency of the rate card must match the currency of the project."},"exclude_archived_stories_percent_complete":{"type":"boolean","description":"Whether archived tasks are excluded from the calculation of the project completion percentage."},"revenue_recognition_method_id":{"type":"string","description":"The criteria that determines how the project's revenue is recognized and accounted for. The ID is a composite ID made up of a numerical ID (unique to each account), a colon, and the method type. For example `123:percent_complete`. Use the [fetching a list of revenue recognition methods endpoint](/kantata/specification/revenue-recognition-methods/get-revenue-recognition-methods) to get the IDs specific to your account. Set to `null` to remove a workspace's revenue recognition method.\n\nThis setting is available only when the [early access feature Revenue Management](https://knowledge.kantata.com/hc/en-us/articles/38986877019803-Revenue-Management-Early-Access) is activated."},"revenue_recognition_method_name":{"type":"string","description":"The criteria that determines how the project's revenue is recognized and accounted for. Default options are `Time & Materials`, `% Complete (Hours)`, and `% Complete (Cost)`. Set to `null` to remove a workspace's revenue recognition method.\n\nThis setting is available only when the [early access feature Revenue Management](https://knowledge.kantata.com/hc/en-us/articles/38986877019803-Revenue-Management-Early-Access) is activated."},"tasks_default_non_billable":{"type":"boolean","description":"Whether tasks in the project default to non-billable."},"stories_are_fixed_fee_by_default":{"type":"boolean","description":"Whether tasks in the project default to fixed fee (`true`) or time and materials (`false`)."},"expenses_in_burn_rate":{"type":"boolean","description":"Sets whether both expenses and invoice additional items should be included in the actual fees calculation for the project. Note that setting this field sets the values of both `actual_fees_includes_expenses` and `actual_fees_includes_additional_line_items`. To set the values individually, set `actual_fees_includes_expenses` and `actual_fees_includes_additional_line_items` instead."},"actual_fees_includes_expenses":{"type":"boolean","description":"Sets whether expenses should be included in the actual fees calculation for the project."},"actual_fees_includes_additional_line_items":{"type":"boolean","description":"Sets whether invoice additional items should be included in the actual fees calculation for the project."},"posts_require_privacy_decision":{"type":"boolean","description":"Whether project posts are visible to everyone in the project (`false`) or are private (`true`) by default."},"status_key":{"type":"integer","format":"int32","description":"The status of the project. See the [Knowledge Base](https://knowledge.kantata.com/hc/en-us/articles/115005042433-Project-Status#Project-Status-List) for a list of project status IDs."},"invoice_preference":{"type":"object","description":"Invoice customization preferences that will be automatically generated in each invoice for the project.","properties":{"client_invoice_address":{"type":"string","description":"The client address to automatically generate in each new invoice."},"client_invoice_name":{"type":"string","description":"The client name to automatically generate in each new invoice."},"consultant_invoice_address":{"type":"string","description":"The provider address to automatically generate in each new invoice."},"consultant_invoice_name":{"type":"string","description":"The provider name to automatically generate in each new invoice."},"project_code":{"type":"string","description":"The project code to automatically generate in each new invoice."},"purchase_order":{"type":"string","description":"The purchase order to automatically generate in each new invoice."}}},"approver_id":{"type":"integer","format":"int32","description":"The user ID of the designated time approver for the project."},"workspace_group_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of the [groups](/tag/Workspace-Groups) the project belongs to."},"project_template_start_date":{"type":"string","format":"date","description":"When `project_tracker_template_id` is provided, this sets the start date that tasks will be based on when the template is applied. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"project_template_checklist_as_todos":{"type":"boolean","description":"Whether checklist items are converted to To Dos when applying a template."},"project_template_assignment_mappings":{"type":"array","description":"When `project_tracker_template_id` is provided, this maps template resources to named or unnamed resources when the template is applied. If named resources are specified via the `user_id` field, the users should also be included in the `participations` field.","items":{"type":"object","properties":{"resource_id":{"type":"integer","format":"int32","description":"The ID of the [project template assignment](/tag/Project-Template-Assignments) this mapping is for."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user to map the template resource to. If you pass a `user_id` and do not set `role_id`, the workspace resource's role will be the user's default account role or—if they have none—it will be blank."},"role_id":{"type":"integer","format":"int32","description":"The ID of the account role to use as the workspace role for this template resource. If you pass a `role_id` but do not pass a `user_id`, an unnamed resource will be created."}}}},"project_template_weekends_as_workdays":{"type":"boolean","description":"When `project_tracker_template_id` is provided, this sets whether weekends count as work days when applying the template. If `true`, weekend days will be included in task durations."},"project_template_create_unnamed_resources":{"type":"boolean","description":"When `project_tracker_template_id` is provided, this maps all template resources and task assignments to unnamed resources, and ignores `project_template_assignment_mappings` for task assignments."},"project_template_distribute_hours":{"type":"boolean","description":"When `project_tracker_template_id` is provided, this sets whether task estimated hours in the template are automatically added as scheduled hours for all tasks when applying the template. The hours will be distributed evenly between the task start date and end date."},"project_tracker_template_id":{"type":"integer","format":"int32","description":"The ID of the template to use to populate tasks and other information in the project."},"primary_workspace_group_id":{"type":"integer","format":"int32","description":"The ID of the [group](/tag/Workspace-Groups) that is the primary group for the project."},"target_margin":{"type":"integer","format":"int32","description":"The desired profit, expressed as a percentage."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]},"account_color_id":{"type":"integer","format":"int32","description":"The ID of the [account color](/tag/Account-Colors) to apply to the project."},"external_link":{"type":"object","description":"A link to display within the project workspace. Requires the Project Button facilitated feature.","properties":{"text":{"type":"string","description":"The URL of the link."},"url":{"type":"string","description":"The button text."}}},"account_insights_mapping_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of Insights dynamic dashboards to add to the project."},"custom_fields":{"type":"array","description":"Custom field values for the project.","items":{"type":"object","properties":{"custom_field_id":{"type":"integer","format":"int32","description":"The ID of the custom field."},"value":{"type":"string","description":"The value for the corresponding custom field. The value formats for different types are:\n\n* `string` - ``, eg. `'foo'`\n* `date` - `` eg. `'2014-02-25'` `(accepted range: '1900-01-01' to '2015-12-31')`\n* `number` - `` eg. `'13'`\n* `currency` - `[, ]` eg. `'[998, USD]'`\n* `single` and `multi` - `[]` eg. `'[1, 2, 4]'`."}}}},"stage":{"type":"string","description":"The stage of the project. Options are `estimate` and `project`.","enum":["estimate","project"]},"require_notes_on_time_entries":{"type":"boolean","description":"Whether notes are required on time entries logged against this project."},"time_trackable":{"type":"boolean","description":"Sets whether tasks in the project can have time tracked to them. This field is only usable if allowed by [Time & Expense account settings](https://knowledge.kantata.com/hc/en-us/articles/360000317994-Time-Expense-Settings)."},"title":{"type":"string"},"creator_role":{"type":"string","description":"Which team to add the project creator to. Options are `maven` / `consultant` (i.e. the provider team) and `buyer` / `client` (i.e. the client team). Defaults to `maven`.","enum":["client","consultant"]},"price":{"type":"integer","format":"int32","description":"The starting budget of the project. This is required for budgeted projects."},"change_orders_enabled":{"type":"boolean","description":"Whether schedule and budget changes require approval.\n\nDefaults to `true` if the project is budgeted."},"change_orders":{"type":"boolean","description":"Whether schedule and budget changes require approval.\n\nDefaults to `true` if the project is budgeted."},"organizations":{"type":"array","description":"The [organizations](/tag/Organizations) to assign to the project.","items":{"type":"object","properties":{"department_id":{"type":"integer","format":"int32","description":"The ID of the department to assign to the project."},"geography_id":{"type":"integer","format":"int32","description":"The ID of the geographic region to assign to the project."}}}},"participations":{"type":"array","description":"Users to add to the project on the provider team.","items":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32","description":"The user ID of the user to add as a participant on the provider team."},"access":{"type":"string","description":"The project permission to assign to the project participant. Legacy options included `collaboration`, `time_logging`, `financial`.","enum":["edit_tasks","view_tasks","edit_time_and_expenses","view_time_and_expenses","edit_financials","view_financials","admin"]}}}},"primary_maven_id":{"type":"integer","format":"int32","description":"The ID of the user to set as the team lead on the provider team.\n\nNote: To change the provider team lead after the project has been created, use the [update participation endpoint](/tag/Participations#operation/update-participation)."},"require_expense_approvals":{"type":"boolean","description":"Whether expenses logged to the project must be approved."},"require_time_approvals":{"type":"boolean","description":"Whether time tracked to the project must be approved."},"estimate_scenario_id":{"type":"integer","format":"int32","description":"The ID of the estimate scenario to create this project from. Must also provide a `start_date`."},"attachment_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of file attachments to associate with the project after it is created."},"task_status_set_id":{"type":"integer","format":"int32","description":"The task status set to assign to the workspace."}},"required":["title"]}}},"id":"schema_511"},"schema_512":{"kind":"json-schema","data":{"type":"object","properties":{"workspace":{"type":"object","properties":{"consultant_role_name":{"type":"string","description":"The label for the consultant team (i.e. the team providing the service)."},"client_role_name":{"type":"string","description":"The label for the client team (i.e. the team paying for the service)."},"budgeted":{"type":"boolean","description":"Whether the project is budgeted.\nDefaults to `true` for paid accounts.\nDefaults to `false` for free accounts."},"start_date":{"type":"string","format":"date","description":"When the project starts. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"due_date":{"type":"string","format":"date","description":"When the project is due. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"description":{"type":"string","description":"The description of the project."},"currency":{"type":"string","description":"The currency of the project.\nOnly applicable if `budgeted` is true.\nSee the [Knowledge Base](https://knowledge.kantata.com/hc/en-us/articles/360041576473) for the list of currency codes.\nDefaults to the account currency or `USD`.\nIf a `rate_card_id` is provided, this field is ignored."},"access_level":{"type":"string","description":"Whether the project is open, and who can join the project.","enum":["invitation","open","admins"]},"rate_card_id":{"type":"integer","format":"int32","description":"The ID of the rate card for the project. The currency of the rate card must match the currency of the project."},"exclude_archived_stories_percent_complete":{"type":"boolean","description":"Whether archived tasks are excluded from the calculation of the project completion percentage."},"revenue_recognition_method_id":{"type":"string","description":"The criteria that determines how the project's revenue is recognized and accounted for. The ID is a composite ID made up of a numerical ID (unique to each account), a colon, and the method type. For example `123:percent_complete`. Use the [fetching a list of revenue recognition methods endpoint](/kantata/specification/revenue-recognition-methods/get-revenue-recognition-methods) to get the IDs specific to your account. Set to `null` to remove a workspace's revenue recognition method.\n\nThis setting is available only when the [early access feature Revenue Management](https://knowledge.kantata.com/hc/en-us/articles/38986877019803-Revenue-Management-Early-Access) is activated."},"revenue_recognition_method_name":{"type":"string","description":"The criteria that determines how the project's revenue is recognized and accounted for. Default options are `Time & Materials`, `% Complete (Hours)`, and `% Complete (Cost)`. Set to `null` to remove a workspace's revenue recognition method.\n\nThis setting is available only when the [early access feature Revenue Management](https://knowledge.kantata.com/hc/en-us/articles/38986877019803-Revenue-Management-Early-Access) is activated."},"tasks_default_non_billable":{"type":"boolean","description":"Whether tasks in the project default to non-billable."},"stories_are_fixed_fee_by_default":{"type":"boolean","description":"Whether tasks in the project default to fixed fee (`true`) or time and materials (`false`)."},"expenses_in_burn_rate":{"type":"boolean","description":"Sets whether both expenses and invoice additional items should be included in the actual fees calculation for the project. Note that setting this field sets the values of both `actual_fees_includes_expenses` and `actual_fees_includes_additional_line_items`. To set the values individually, set `actual_fees_includes_expenses` and `actual_fees_includes_additional_line_items` instead."},"actual_fees_includes_expenses":{"type":"boolean","description":"Sets whether expenses should be included in the actual fees calculation for the project."},"actual_fees_includes_additional_line_items":{"type":"boolean","description":"Sets whether invoice additional items should be included in the actual fees calculation for the project."},"posts_require_privacy_decision":{"type":"boolean","description":"Whether project posts are visible to everyone in the project (`false`) or are private (`true`) by default."},"status_key":{"type":"integer","format":"int32","description":"The status of the project. See the [Knowledge Base](https://knowledge.kantata.com/hc/en-us/articles/115005042433-Project-Status#Project-Status-List) for a list of project status IDs."},"invoice_preference":{"type":"object","description":"Invoice customization preferences that will be automatically generated in each invoice for the project.","properties":{"client_invoice_address":{"type":"string","description":"The client address to automatically generate in each new invoice."},"client_invoice_name":{"type":"string","description":"The client name to automatically generate in each new invoice."},"consultant_invoice_address":{"type":"string","description":"The provider address to automatically generate in each new invoice."},"consultant_invoice_name":{"type":"string","description":"The provider name to automatically generate in each new invoice."},"project_code":{"type":"string","description":"The project code to automatically generate in each new invoice."},"purchase_order":{"type":"string","description":"The purchase order to automatically generate in each new invoice."}}},"approver_id":{"type":"integer","format":"int32","description":"The user ID of the designated time approver for the project."},"workspace_group_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of the [groups](/tag/Workspace-Groups) the project belongs to."},"project_template_start_date":{"type":"string","format":"date","description":"When `project_tracker_template_id` is provided, this sets the start date that tasks will be based on when the template is applied. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"project_template_checklist_as_todos":{"type":"boolean","description":"Whether checklist items are converted to To Dos when applying a template."},"project_template_assignment_mappings":{"type":"array","description":"When `project_tracker_template_id` is provided, this maps template resources to named or unnamed resources when the template is applied. If named resources are specified via the `user_id` field, the users should also be included in the `participations` field.","items":{"type":"object","properties":{"resource_id":{"type":"integer","format":"int32","description":"The ID of the [project template assignment](/tag/Project-Template-Assignments) this mapping is for."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user to map the template resource to. If you pass a `user_id` and do not set `role_id`, the workspace resource's role will be the user's default account role or—if they have none—it will be blank."},"role_id":{"type":"integer","format":"int32","description":"The ID of the account role to use as the workspace role for this template resource. If you pass a `role_id` but do not pass a `user_id`, an unnamed resource will be created."}}}},"project_template_weekends_as_workdays":{"type":"boolean","description":"When `project_tracker_template_id` is provided, this sets whether weekends count as work days when applying the template. If `true`, weekend days will be included in task durations."},"project_template_create_unnamed_resources":{"type":"boolean","description":"When `project_tracker_template_id` is provided, this maps all template resources and task assignments to unnamed resources, and ignores `project_template_assignment_mappings` for task assignments."},"project_template_distribute_hours":{"type":"boolean","description":"When `project_tracker_template_id` is provided, this sets whether task estimated hours in the template are automatically added as scheduled hours for all tasks when applying the template. The hours will be distributed evenly between the task start date and end date."},"project_tracker_template_id":{"type":"integer","format":"int32","description":"The ID of the template to use to populate tasks and other information in the project."},"primary_workspace_group_id":{"type":"integer","format":"int32","description":"The ID of the [group](/tag/Workspace-Groups) that is the primary group for the project."},"target_margin":{"type":"integer","format":"int32","description":"The desired profit, expressed as a percentage."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]},"account_color_id":{"type":"integer","format":"int32","description":"The ID of the [account color](/tag/Account-Colors) to apply to the project."},"external_link":{"type":"object","description":"A link to display within the project workspace. Requires the Project Button facilitated feature.","properties":{"text":{"type":"string","description":"The URL of the link."},"url":{"type":"string","description":"The button text."}}},"account_insights_mapping_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of Insights dynamic dashboards to add to the project."},"custom_fields":{"type":"array","description":"Custom field values for the project.","items":{"type":"object","properties":{"custom_field_id":{"type":"integer","format":"int32","description":"The ID of the custom field."},"value":{"type":"string","description":"The value for the corresponding custom field. The value formats for different types are:\n\n* `string` - ``, eg. `'foo'`\n* `date` - `` eg. `'2014-02-25'` `(accepted range: '1900-01-01' to '2015-12-31')`\n* `number` - `` eg. `'13'`\n* `currency` - `[, ]` eg. `'[998, USD]'`\n* `single` and `multi` - `[]` eg. `'[1, 2, 4]'`."}}}},"stage":{"type":"string","description":"The stage of the project. Options are `estimate` and `project`.","enum":["estimate","project"]},"require_notes_on_time_entries":{"type":"boolean","description":"Whether notes are required on time entries logged against this project."},"time_trackable":{"type":"boolean","description":"Sets whether tasks in the project can have time tracked to them. This field is only usable if allowed by [Time & Expense account settings](https://knowledge.kantata.com/hc/en-us/articles/360000317994-Time-Expense-Settings)."},"title":{"type":"string"},"archived":{"type":"boolean","description":"Set to `true` to archive the project or to `false` to unarchive the project."},"price":{"type":"integer","format":"int32","description":"The project budget, in base units of the currency (e.g. dollars for `USD` )."},"project_template_before_story_id":{"type":"integer","format":"int32","description":"When `project_tracker_template_id` is provided, the template tasks are inserted after the provided task ID. The provided task ID must belong to an existing and top-level task."},"change_orders_enabled":{"type":"boolean","description":"Whether approval is required for schedule and budget change orders."},"task_status_set_id":{"type":"integer","format":"int32","description":"The task status set to assign to the workspace. All stories in the workspace must have a default task status—`not started`, `started`, `needs info`, and `completed`—in their `status` field in order to change the task status set."}}}}},"id":"schema_512"},"schema_513":{"kind":"json-schema","data":{"type":"object","properties":{"workspace":{"type":"object","properties":{"project_tracker_template_id":{"type":"integer","format":"int32","description":"The ID of the template to use to populate tasks and other information in the project."},"project_template_weekends_as_workdays":{"type":"boolean","description":"Whether weekends count as work days when applying the template. If `true`, weekend days will be included in task durations."},"project_template_start_date":{"type":"string","format":"date","description":"The start date that tasks will be based on when the template is applied. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"project_template_checklist_as_todos":{"type":"boolean","description":"Whether checklist items are converted to To Dos when applying the template."},"project_template_create_unnamed_resources":{"type":"boolean","description":"If `true`, all template resources and task assignments will be mapped to unnamed\nresources and `project_template_assignment_mappings` will be ignored."},"project_template_distribute_hours":{"type":"boolean","description":"Whether task estimated hours in the template are automatically added as scheduled hours\nfor all tasks when applying the template. The hours will be distributed evenly between\nthe task start date and end date."},"project_template_assignment_mappings":{"type":"array","description":"This maps template resources to named or unnamed resources when the template is applied.","items":{"type":"object","properties":{"role_id":{"type":"integer","format":"int32","description":"The ID of the account role to use as the workspace role for this template resource. If you pass a `role_id` but do not pass a `user_id`, an unnamed resource will be created."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user to map the template resource to. If you pass a `user_id` and do not set `role_id`, the workspace resource's role will be the user's default account role or—if they have none—it will be blank."},"resource_id":{"type":"integer","format":"int32","description":"The ID of the [project template assignment](/tag/Project-Template-Assignments) this mapping is for."},"create_unnamed_resource":{"type":"boolean","description":"If this is `true` and no `user_id` is specified, a new unnamed resource will be created for this template resource using the specified role, and the tasks will be assigned to the unnamed resource."}}}},"project_template_before_story_id":{"type":"integer","format":"int32","description":"The ID of an existing task the template tasks should be inserted after. The provided task ID must belong to a top-level task."}}}}},"id":"schema_513"},"schema_514":{"kind":"json-schema","data":{"type":"object","properties":{"invitation":{"type":"object","properties":{"full_name":{"type":"string","description":"The name of the user to invite to the project. If the user does not already exist in Kantata OX, this will become their name on your account."},"email_address":{"type":"string","description":"The email address to send the workspace invitation to."},"invitee_role":{"type":"string","description":"The team to add the invited user to. Options are `maven` (i.e. consultant) and `buyer` (i.e. client)."},"subject":{"type":"string","description":"The subject of the invitation email. If not set, the default subject is used."},"message":{"type":"string","description":"The message to include within the body of the invitation email. If not set, the default message is used."}},"required":["full_name","email_address","invitee_role"]}}},"id":"schema_514"},"schema_515":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"workspace_invitations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceInvitation"}}}},"id":"schema_515"},"schema_516":{"kind":"json-schema","data":{"type":"object","properties":{"can_change_budgetability":{"type":"boolean","description":"Whether the user has permission to change the project budget settings."},"can_change_currency":{"type":"boolean","description":"Whether currency can be changed for the project."},"can_change_time_approvals":{"type":"boolean","description":"Whether the user has permission to change the time approval settings, and whether changing time\napproval settings is allowed in the project."},"can_change_expense_approvals":{"type":"boolean","description":"Whether the user has permission to change the expense approval settings, and whether changing the\nexpense approval settings is allowed in the project."},"can_edit_change_orders":{"type":"boolean","description":"Whether project change orders can be disabled."},"can_edit_project_settings":{"type":"boolean","description":"Whether the user has permission to edit settings in the project."},"can_edit_team_names":{"type":"boolean","description":"Whether the user has permission to edit team names in the project."},"can_manage_invoice_preferences":{"type":"boolean","description":"Whether the user has permission to edit invoice preferences in the project."},"can_manage_finance":{"type":"boolean","description":"Whether the user has permission (and the account has access) to project finance settings."},"can_view_insights_dynamic_dashboards":{"type":"boolean","description":"Whether the user has permission to view dynamic dashboards on the account."}}},"id":"schema_516"},"schema_517":{"kind":"json-schema","data":{"type":"object","properties":{"workspace":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether expense approvals should be enabled."},"backfill_date":{"type":"string","format":"date","description":"If `enable` is true, this is the date through which to approve existing expenses. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}}}}},"id":"schema_517"},"schema_518":{"kind":"json-schema","data":{"type":"object","properties":{"workspace":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether time approvals should be enabled."},"backfill_date":{"type":"string","format":"date","description":"If `enable` is true, this is the date through which to approve existing time entries. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}}}}},"id":"schema_518"},"schema_519":{"kind":"json-schema","data":{"type":"object","properties":{"activated":{"type":"boolean","description":"Indicates whether the Rate Card feature has been enabled on the user's account."}}},"id":"schema_519"},"schema_520":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"rate_card_roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardRole"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}},"rate_card_versions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardVersion"}}}},"id":"schema_520"},"schema_521":{"kind":"json-schema","data":{"type":"object","properties":{"rate_card_role":{"type":"object","properties":{"rate_card_version_id":{"type":"integer","format":"int32","description":"The ID of the Rate Card Version to which the Rate Card Role belongs."},"role_id":{"type":"integer","format":"int32","description":"The ID of the Role being represented by the Rate Card Role."},"rate":{"type":"integer","format":"int32","description":"The bill rate, in cents per hour, for the associated role."}},"required":["rate_card_version_id","role_id","rate"]}}},"id":"schema_521"},"schema_522":{"kind":"json-schema","data":{"type":"object","properties":{"rate_card_role":{"type":"object","properties":{"rate":{"type":"integer","format":"int32","description":"The bill rate, in cents per hour, for the associated role."}}}}},"id":"schema_522"},"schema_523":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"rate_card_set_versions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardSetVersion"}},"rate_card_sets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardSet"}},"rate_card_versions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardVersion"}}}},"id":"schema_523"},"schema_524":{"kind":"json-schema","data":{"type":"object","properties":{"rate_card_set_version":{"type":"object","properties":{"rate_card_set_id":{"type":"integer","format":"int32","description":"The ID of the Rate Card Set to which this version belongs."},"effective_date":{"type":"string","format":"date","description":"The date from the which the current rate card set version takes effect. This will default to today. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}},"required":["rate_card_set_id"]}}},"id":"schema_524"},"schema_525":{"kind":"json-schema","data":{"type":"object","properties":{"rate_card_set_version":{"type":"object","properties":{"effective_date":{"type":"string","format":"date","description":"The date from the which the current Rate Card Set Version takes effect. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}}}}},"id":"schema_525"},"schema_526":{"kind":"json-schema","data":{"type":"object","properties":{"activated":{"type":"boolean","description":"Indicates whether the Rate Card Set Version has been published."}}},"id":"schema_526"},"schema_527":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"rate_card_sets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardSet"}},"rate_cards":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCard"}},"rate_card_set_versions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardSetVersion"}},"workspace_groups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceGroup"}}}},"id":"schema_527"},"schema_528":{"kind":"json-schema","data":{"type":"object","properties":{"rate_card_set":{"type":"object","properties":{"title":{"type":"string","description":"The title of the Rate Card Set."}},"required":["title"]}}},"id":"schema_528"},"schema_529":{"kind":"json-schema","data":{"type":"object","properties":{"rate_card_set":{"type":"object","properties":{"title":{"type":"string","description":"The title of the Rate Card Set."}}}}},"id":"schema_529"},"schema_530":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The number of Rate Card Table Rows in the Rate Card Set Version."},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The number of Rate Card Table Rows in the Rate Card Set Version."},"page_count":{"type":"integer","format":"int32","description":"The total number of pagination pages."},"page_number":{"type":"integer","format":"int32","description":"The current pagination page."},"page_size":{"type":"integer","format":"int32","description":"The number of Rate Card Table Rows in a pagination page."}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string","description":"The ID of the Rate Card Table Row, defined as ``:``."}}}},"rate_card_table_rows":{"type":"object","description":"Rate card table rows keyed by composite `:`.","properties":{"id":{"type":"string","description":"The ID of the Rate Card Table Row, defined as ``:``."},"rate_card_set_id":{"type":"integer","format":"int32","description":"The ID of the Rate Card Set."},"rate_card_set_version_id":{"type":"integer","format":"int32","description":"The ID of the Rate Card Table Set Version."},"role_id":{"type":"integer","format":"int32","description":"The ID of the Role."},"name":{"type":"string","description":"The name of the Role."},"removable":{"type":"boolean","description":"If `true`, this Rate Card Table Row is removable."},"cells":{"type":"object","description":"Per-currency rate cells keyed by ISO currency code.","properties":{"rate_card_role_id":{"type":"integer","format":"int32","description":"The ID of the Rate Card Role for the specified currency."},"rate":{"type":"integer","format":"int32","description":"The rate for the specified Rate Card Role."}}}}}}},"id":"schema_530"},"schema_531":{"kind":"json-schema","data":{"type":"object","properties":{"rate_card_table_row":{"type":"object","properties":{"rates":{"type":"array","description":"The currencies and rates for each row.","items":{"type":"object","properties":{"currency":{"type":"string","description":"The [ISO code](https://mavenlink.zendesk.com/hc/en-us/articles/360041576473)\n of the currency."},"rate":{"type":"integer","format":"int32","description":"The rate in subunits (e.g. 25000 cents = 250 dollars)."}},"required":["currency","rate"]}}},"required":["rates"]}}},"id":"schema_531"},"schema_532":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"rate_card_versions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardVersion"}},"rate_cards":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCard"}},"rate_card_set_versions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardSetVersion"}},"rate_card_roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardRole"}}}},"id":"schema_532"},"schema_533":{"kind":"json-schema","data":{"type":"object","properties":{"rate_card_version":{"type":"object","properties":{"default_rate":{"type":"integer","format":"int32","description":"The default rate for all roles that do not have explicit rates associated with them."}},"required":["default_rate"]}}},"id":"schema_533"},"schema_534":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"rate_cards":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCard"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"rate_card_sets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardSet"}},"rate_card_versions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RateCardVersion"}}}},"id":"schema_534"},"schema_535":{"kind":"json-schema","data":{"type":"object","properties":{"rate_card":{"type":"object","properties":{"rate_card_set_id":{"type":"integer","format":"int32","description":"The ID of the Rate Card Set to which the Rate Card belongs."},"rate_card_set_version_id":{"type":"integer","format":"int32","description":"The ID of the Rate Card Set Version to which the Rate Card belongs."},"currency":{"type":"string","description":"The currency that the Rate Card represents in the Rate Card. For example, `USD`."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["rate_card_set_id","currency"]}}},"id":"schema_535"},"schema_536":{"kind":"json-schema","data":{"type":"object","properties":{"rate_card":{"type":"object","properties":{"currency":{"type":"string","description":"The currency that the Rate Card will represent in the Rate Card Set. For example, `USD`."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_536"},"schema_537":{"kind":"json-schema","data":{"type":"object","properties":{"total_count":{"type":"integer","format":"int32","description":"Total number of recommendations returned."},"recommendations":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32","description":"The ID of the user that is recommended."},"rank":{"type":"integer","format":"int32","description":"The rank of the user that is recommended."}}}}}},"id":"schema_537"},"schema_538":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"resource_requests":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ResourceRequest"}},"workspace_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceResource"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}}}},"id":"schema_538"},"schema_539":{"kind":"json-schema","data":{"type":"object","properties":{"resource_request":{"type":"object","properties":{"resource_id":{"type":"integer","format":"int32","description":"The ID of the resource for which the resource request will be created."},"resource_workspace_id":{"type":"integer","format":"int32","description":"A resource will be created for this project in addition to the resource request."},"resource_role_id":{"type":"integer","format":"int32","description":"A resource will be created with this role in addition to the resource request."},"approver_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The IDs of the people selected to approve this request."},"workspace_allocation_start_date":{"type":"string","format":"date","description":"Set the allocation start date for a created workspace resource. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"workspace_allocation_end_date":{"type":"string","format":"date","description":"Set the allocation start date for a created workspace resource. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"workspace_allocation_percentage":{"type":"integer","format":"int32","description":"Set the allocation percentage for a created workspace resource."},"custom_fields":{"type":"array","description":"Determines the custom field values for the workspace resource.","items":{"type":"object","properties":{"custom_field_id":{"type":"integer","format":"int32","description":"The ID of the custom field."},"value":{"type":"string","description":"The value for the corresponding custom field. The value formats for different types are:\n\n* `string` - ``, eg. `'foo'`\n* `date` - `` eg. `'2014-02-25'` `(accepted range: '1900-01-01' to '2015-12-31')`\n* `number` - `` eg. `'13'`\n* `currency` - `[, ]` eg. `'[998, USD]'`\n* `single` and `multi` - `[]` eg. `'[1, 2, 4]'`."}}}}},"required":["approver_ids"]}}},"id":"schema_539"},"schema_540":{"kind":"json-schema","data":{"type":"object","properties":{"resource_request":{"type":"object","properties":{"request_resolution_status":{"type":"string","description":"The state for request resolution, one of approve, reject, or cancel."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user being named (staffed) on this unnamed resource."},"allocations_state":{"type":"boolean","description":"Whether to set the allocations to hard or soft allocated when naming the resource. When nothing is passed in, the allocations are defaulted to hard allocated."}},"required":["request_resolution_status"]}}},"id":"schema_540"},"schema_541":{"kind":"json-schema","data":{"type":"object","properties":{"resource_request":{"type":"object","properties":{"new_approver_id":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The ID of the user who is the new approver."}},"required":["new_approver_id"]}}},"id":"schema_541"},"schema_542":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"holiday_calendar_associations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HolidayCalendarAssociation"}},"holidays":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Holiday"}},"holiday_calendars":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HolidayCalendar"}}}},"id":"schema_542"},"schema_543":{"kind":"json-schema","data":{"type":"object","properties":{"holiday_calendar_association":{"type":"object","properties":{"holiday_id":{"type":"integer","format":"int32","description":"The ID of the holiday to be associated with a calendar."},"holiday_calendar_id":{"type":"integer","format":"int32","description":"The ID of the calendar to be associated with a holiday."}},"required":["holiday_id","holiday_calendar_id"]}}},"id":"schema_543"},"schema_544":{"kind":"json-schema","data":{"type":"string","default":"start_date:desc"},"id":"schema_544"},"schema_545":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"holiday_calendar_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HolidayCalendarMembership"}},"holiday_calendars":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HolidayCalendar"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}}}},"id":"schema_545"},"schema_546":{"kind":"json-schema","data":{"type":"object","properties":{"holiday_calendar_membership":{"type":"object","properties":{"start_date":{"type":"string","format":"date","description":"When the calendar begins to apply to the user. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"holiday_calendar_id":{"type":"integer","format":"int32","description":"The ID of the calendar that is associated to the user."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user assigned to the calendar."}},"required":["start_date","holiday_calendar_id","user_id"]}}},"id":"schema_546"},"schema_547":{"kind":"json-schema","data":{"type":"object","properties":{"holiday_calendar_membership":{"type":"object","properties":{"start_date":{"type":"string","format":"date","description":"The new date that the calendar begins to apply to the user. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"holiday_calendar_id":{"type":"integer","format":"int32","description":"The ID of the calendar that is associated to the user."}}}}},"id":"schema_547"},"schema_548":{"kind":"json-schema","data":{"type":"string","default":"default"},"id":"schema_548"},"schema_549":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"holiday_calendars":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HolidayCalendar"}}}},"id":"schema_549"},"schema_550":{"kind":"json-schema","data":{"type":"object","properties":{"holiday_calendar":{"type":"object","properties":{"name":{"type":"string","description":"The name of the holiday calendar."}},"required":["name"]}}},"id":"schema_550"},"schema_551":{"kind":"json-schema","data":{"type":"object","properties":{"holiday_calendar":{"type":"object","properties":{"name":{"type":"string","description":"The name to which the holiday calendar is being changed."}},"required":["name"]}}},"id":"schema_551"},"schema_552":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["calendar_names_list"]}},"id":"schema_552"},"schema_553":{"kind":"json-schema","data":{"type":"string","default":"start_date:asc"},"id":"schema_553"},"schema_554":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"holidays":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Holiday"}},"holiday_calendar_associations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HolidayCalendarAssociation"}}}},"id":"schema_554"},"schema_555":{"kind":"json-schema","data":{"type":"object","properties":{"holiday":{"type":"object","properties":{"name":{"type":"string","description":"The name of the holiday."},"start_date":{"type":"string","format":"date","description":"The date the holiday begins. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"end_date":{"type":"string","format":"date","description":"The date the holiday ends. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"paid":{"type":"boolean","description":"Whether this time range is considered paid time off."},"holiday_calendar_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The calendars to which this holiday belongs."}},"required":["name","start_date"]}}},"id":"schema_555"},"schema_556":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"time_off_entries":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TimeOffEntry"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}}}},"id":"schema_556"},"schema_557":{"kind":"json-schema","data":{"type":"object","properties":{"time_off_entry":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32","description":"The ID of the user who has requested time off."},"hours":{"type":"number","format":"float","description":"The number of hours of time off requested for the day (quarter hour increments recommended)."},"requested_date":{"type":"string","format":"date","description":"The date for which time off is requested. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["user_id","hours","requested_date"]},"time_off_entries":{"type":"array","description":"Multiple time off entries and their attributes in an array.","items":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32","description":"The ID of the user who has requested time off."},"hours":{"type":"number","format":"float","description":"The number of hours of time off requested for the day (quarter hour increments recommended)."},"requested_date":{"type":"string","format":"date","description":"The date for which time off is requested. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["user_id","hours","requested_date"]}}}},"id":"schema_557"},"schema_558":{"kind":"json-schema","data":{"type":"object","properties":{"time_off_entry":{"type":"object","properties":{"hours":{"type":"number","format":"float","description":"The number of hours of time off requested for the day (quarter hour increments recommended)."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["hours"]}}},"id":"schema_558"},"schema_559":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"workweek_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkweekMembership"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workweeks":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workweek"}}}},"id":"schema_559"},"schema_560":{"kind":"json-schema","data":{"type":"object","properties":{"workweek_membership":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32","description":"The ID of the user to whom the workweek belongs."},"start_date":{"type":"string","format":"date","description":"The start date of the workweek (must be a Sunday). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"sunday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Sunday."},"monday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Monday."},"tuesday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Tuesday."},"wednesday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Wednesday."},"thursday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Thursday."},"friday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Friday."},"saturday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Saturday."}},"required":["user_id"]}}},"id":"schema_560"},"schema_561":{"kind":"json-schema","data":{"type":"object","properties":{"workweek_membership":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32","description":"The ID of the user being switched to the default workeek."},"start_date":{"type":"string","format":"date","description":"Switches to default workweek from the specified date. If not specified, defaults to today. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}}}}},"id":"schema_561"},"schema_562":{"kind":"json-schema","data":{"type":"object","properties":{"workweek_membership":{"type":"object","properties":{"start_date":{"type":"string","format":"date","description":"The start date of the workweek (must be a Sunday). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"sunday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Sunday."},"monday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Monday."},"tuesday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Tuesday."},"wednesday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Wednesday."},"thursday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Thursday."},"friday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Friday."},"saturday_minutes":{"type":"integer","format":"int32","description":"The number of available working minutes on Saturday."}}}}},"id":"schema_562"},"schema_563":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"workweeks":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workweek"}},"workweek_memberships":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkweekMembership"}}}},"id":"schema_563"},"schema_564":{"kind":"json-schema","data":{"type":"object","properties":{"workweek":{"type":"object","properties":{"start_date":{"type":"string","format":"date","description":"The start date of the workweek (must be a Sunday). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"sunday_minutes":{"type":"integer","format":"int32","description":"The number of workable minutes on Sunday."},"monday_minutes":{"type":"integer","format":"int32","description":"The number of workable minutes on Monday."},"tuesday_minutes":{"type":"integer","format":"int32","description":"The number of workable minutes on Tuesday."},"wednesday_minutes":{"type":"integer","format":"int32","description":"The number of workable minutes on Wednesday."},"thursday_minutes":{"type":"integer","format":"int32","description":"The number of workable minutes on Thursday."},"friday_minutes":{"type":"integer","format":"int32","description":"The number of workable minutes on Friday."},"saturday_minutes":{"type":"integer","format":"int32","description":"The number of workable minutes on Saturday."}}}}},"id":"schema_564"},"schema_565":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"survey_answers":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyAnswer"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"survey_questions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyQuestion"}},"survey_responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyResponse"}}}},"id":"schema_565"},"schema_566":{"kind":"json-schema","data":{"type":"object","properties":{"survey_answer":{"type":"object","properties":{"survey_response_id":{"type":"integer","format":"int32","description":"Survey Response associated with the answer."},"survey_question_id":{"type":"integer","format":"int32","description":"Survey Question that is being answered."},"date_value":{"type":"string","format":"date","description":"The date value for the answer. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"string_value":{"type":"string","description":"The string value for the answer."},"integer_value":{"type":"integer","format":"int32","description":"The integer value for the answer."},"decimal_value":{"type":"number","format":"float","description":"The decimal value for the answer."},"choice_values":{"type":"array","items":{"type":"string"},"description":"An array of choice values for the answer."},"choice_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"An array of choice ids for the answer."}},"required":["survey_response_id","survey_question_id"]}}},"id":"schema_566"},"schema_567":{"kind":"json-schema","data":{"type":"object","properties":{"survey_answer":{"type":"object","properties":{"date_value":{"type":"string","format":"date","description":"The date value for the answer. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"string_value":{"type":"string","description":"The string value for the answer."},"integer_value":{"type":"integer","format":"int32","description":"The integer value for the answer."},"decimal_value":{"type":"number","format":"float","description":"The decimal value for the answer."},"choice_values":{"type":"array","items":{"type":"string"},"description":"An array of choice values for the answer."},"choice_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"An array of choice ids for the answer."}}}}},"id":"schema_567"},"schema_568":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"survey_questions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyQuestion"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}}}},"id":"schema_568"},"schema_569":{"kind":"json-schema","data":{"type":"object","properties":{"survey_question":{"type":"object","properties":{"text":{"type":"string","description":"The text of the question."},"question_type":{"type":"string","description":"The type of the question. Valid values: single, multi, date, string, integer, decimal."},"choices":{"type":"array","description":"List of possible choices for the question. Only valid with single and multiple question type.","items":{"type":"object","properties":{"label":{"type":"string","description":"Display label for the question choice."}}}}},"required":["text","question_type"]}}},"id":"schema_569"},"schema_570":{"kind":"json-schema","data":{"type":"object","properties":{"survey_question":{"type":"object","properties":{"text":{"type":"string","description":"The text of the question."}}}}},"id":"schema_570"},"schema_571":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"survey_templates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyTemplate"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"survey_questions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyQuestion"}},"survey_responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyResponse"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}}}},"id":"schema_571"},"schema_572":{"kind":"json-schema","data":{"type":"object","properties":{"survey_template":{"type":"object","properties":{"survey_question_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Survey Questions to associate with this template."},"title":{"type":"string","description":"The title of the survey."},"description":{"type":"string","description":"The description of the survey."},"subject_type":{"type":"string","description":"The subject type of the survey. Valid values: User, Story, Workspace."},"subject_id":{"type":"integer","format":"int32","description":"The Id of the survey subject."},"owner_id":{"type":"integer","format":"int32","description":"The user who owns all surveys based on this template."},"respondent_id":{"type":"integer","format":"int32","description":"The user assigned to respond to surveys based on this template."},"workspace_id":{"type":"integer","format":"int32","description":"The workspace to be used as context for surveys based on this template."},"open_date":{"type":"string","format":"date","description":"The open date to be used for surveys based on this template. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"close_date":{"type":"string","format":"date","description":"The close date to be used for surveys based on this template. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"due_date":{"type":"string","format":"date","description":"The due date to be used for surveys based on this template. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}},"required":["survey_question_ids"]}}},"id":"schema_572"},"schema_573":{"kind":"json-schema","data":{"type":"object","properties":{"survey_template":{"type":"object","properties":{"title":{"type":"string","description":"The title of the survey."},"description":{"type":"string","description":"The description of the survey."},"owner_id":{"type":"integer","format":"int32","description":"The user who owns all surveys based on this template."},"open_date":{"type":"string","format":"date","description":"The open date for this survey. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"close_date":{"type":"string","format":"date","description":"The close date for this survey. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"due_date":{"type":"string","format":"date","description":"The due date for this survey. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}}}}},"id":"schema_573"},"schema_574":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"survey_responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyResponse"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"survey_templates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyTemplate"}},"survey_answers":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SurveyAnswer"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}}}},"id":"schema_574"},"schema_575":{"kind":"json-schema","data":{"type":"object","properties":{"survey_response":{"type":"object","properties":{"survey_template_id":{"type":"integer","format":"int32","description":"The template that the survey response is based on."},"title":{"type":"string","description":"The title of the survey."},"description":{"type":"string","description":"The description of the survey."},"status":{"type":"string","description":"The status of the survey response."},"subject_type":{"type":"string","description":"The subject type of the survey. Valid values: User, Story, Workspace."},"subject_id":{"type":"integer","format":"int32","description":"The Id of the survey subject."},"owner_id":{"type":"integer","format":"int32","description":"The user who owns the survey response."},"respondent_id":{"type":"integer","format":"int32","description":"The user assigned to complete the survey response."},"workspace_id":{"type":"integer","format":"int32","description":"The workspace the survey is related to."},"open_date":{"type":"string","format":"date","description":"The open date for this survey. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"close_date":{"type":"string","format":"date","description":"The close date for this survey. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"due_date":{"type":"string","format":"date","description":"The due date for this survey. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}},"required":["survey_template_id"]}}},"id":"schema_575"},"schema_576":{"kind":"json-schema","data":{"type":"object","properties":{"survey_response":{"type":"object","properties":{"title":{"type":"string","description":"The title of the survey."},"description":{"type":"string","description":"The description of the survey."},"status":{"type":"string","description":"The status of the survey response."},"owner_id":{"type":"integer","format":"int32","description":"The user who owns the survey response."},"open_date":{"type":"string","format":"date","description":"The open date for this survey. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"close_date":{"type":"string","format":"date","description":"The close date for this survey. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"due_date":{"type":"string","format":"date","description":"The due date for this survey. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}}}}},"id":"schema_576"},"schema_577":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"assignments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Assignment"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"story_allocation_days":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StoryAllocationDay"}}}},"id":"schema_577"},"schema_578":{"kind":"json-schema","data":{"type":"object","properties":{"assignment":{"type":"object","properties":{"story_id":{"type":"integer","format":"int32","description":"The ID of the task being assigned to a resource."},"assignee_id":{"type":"integer","format":"int32","description":"The ID of the user the assignment is for. Provide either `assignee_id` or `resource_id`.\nIf both are provided, `resource_id` overrides `assignee_id`."},"resource_id":{"type":"integer","format":"int32","description":"The ID of the resource the assignment is for. Provide either `resource_id` or `assignee_id`.\nIf both are provided, `resource_id` overrides `assignee_id`."},"current":{"type":"boolean","description":"Whether the assignment is active. `True` indicates an active\nassignment, and `False` indicates inactive.\n\nAssignments cannot be deleted,\nbut are considered inactive when a resource is unassigned from a task."},"estimated_minutes":{"type":"integer","format":"int32","description":"The number of minutes the resource is estimated to work on the task."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["story_id"]}}},"id":"schema_578"},"schema_579":{"kind":"json-schema","data":{"type":"object","properties":{"assignment":{"type":"object","properties":{"assignee_id":{"type":"integer","format":"int32","description":"The ID of the user the assignment is for. Provide either `assignee_id` or `resource_id`.\nIf both are provided, `resource_id` overrides `assignee_id`."},"resource_id":{"type":"integer","format":"int32","description":"The ID of the resource the assignment is for. Provide either `resource_id` or `assignee_id`.\nIf both are provided, `resource_id` overrides `assignee_id`."},"current":{"type":"boolean","description":"Whether the assignment is active. Set as `true` to assign the resource to the task. Set as `false` to unassign the resource from the task."},"estimated_minutes":{"type":"integer","format":"int32","description":"The number of minutes the resource is estimated to work on the task."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}}}}},"id":"schema_579"},"schema_580":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"story_allocation_days":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StoryAllocationDay"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"assignments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Assignment"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}}}},"id":"schema_580"},"schema_581":{"kind":"json-schema","data":{"type":"object","properties":{"story_allocation_day":{"type":"object","properties":{"assignment_id":{"type":"integer","format":"int32","description":"The ID of the Assignment the Daily Scheduled Hours are part of."},"date":{"type":"string","format":"date","description":"The date of the scheduled hours (e.g. 2014-12-31). The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"minutes":{"type":"integer","format":"int32","description":"The amount of time scheduled for the day, in minutes\n (e.g. `120` for 120 minutes, which is 2 hours)."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["assignment_id","date","minutes"]}}},"id":"schema_581"},"schema_582":{"kind":"json-schema","data":{"type":"object","properties":{"story_allocation_day":{"type":"object","properties":{"minutes":{"type":"integer","format":"int32","description":"The amount of time scheduled for the day, in minutes\n (e.g. `120` for 120 minutes, which is 2 hours)."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["minutes"]}}},"id":"schema_582"},"schema_583":{"kind":"json-schema","data":{"type":"object","properties":{"story_follow":{"type":"object","properties":{"story_id":{"type":"integer","format":"int32","description":"The ID of the associated task (story)."},"follower_id":{"type":"integer","format":"int32","description":"The ID of the user to add as a follower."}},"required":["story_id","follower_id"]}}},"id":"schema_583"},"schema_584":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["custom_task_status_id","read_only","can_edit","can_post","archived_editable","is_time_trackable_type","has_out_of_bounds_sads","can_align_time","formatted_description","parsed_description","render_description_markdown"]}},"id":"schema_584"},"schema_585":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"workspace_resources":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/WorkspaceResource"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"assignments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Assignment"}},"story_tasks":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StoryTask"}},"tags":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ActsAsTaggableOn_Tag"}},"story_state_changes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StoryStateChange"}},"posts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Post"}},"attachments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Attachments_PostAttachment"}},"story_dependencies":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StoryDependency"}},"custom_field_values":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomFieldValue"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}}}},"id":"schema_585"},"schema_586":{"kind":"json-schema","data":{"type":"object","properties":{"story":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The workspace ID where this story should be created."},"title":{"type":"string"},"story_type":{"type":"string","description":"Must be one of: 'task', 'deliverable', 'milestone', or 'issue'. Defaults to: 'task'.","enum":["task","deliverable","milestone","issue"]},"description":{"type":"string","description":"Must be less than 1000 characters."},"start_date":{"type":"string","format":"date","description":"Projected start date of the project. Format should look like YYYY-MM-DD. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"due_date":{"type":"string","format":"date","description":"Projected end date of the project. Format should look like YYYY-MM-DD. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"state":{"type":"string","description":"The status type (category). It is recommended to set the `status` field instead (which supports custom task statuses).\n\nPossible options depend on the `story_type`:\n - Possible options for `task`, `deliverable`, and `milestone` are `not started`, `started`, `needs info`, and `completed`.\n - If a task status set has not been applied to the workspace, possible options for `issue` are `new`, `reopened`, `in progress`, `blocked`, `fixed`, `duplicate`, `can't repro`, `resolved`, and `won't fix`.\n Otherwise, possible options are `not started`, `started`, `needs info`, and `completed`.\n\nIf both `status` and `state` are provided, the provided `state` value is ignored and the corresponding `category` of the provided `status` is applied to the `state` field instead.","enum":["not started","started","needs info","completed","new","reopened","in progress","blocked","fixed","duplicate","can't repro","resolved","won't fix"]},"status":{"type":"string","description":"The status of the story. Possible options depend on whether the workspace has an assigned task status set.\n - If the workspace does not have a task status set assigned, possible options are `not started`, `started`, `needs info`, and `completed`.\n - If the workspace has a task status set assigned, the possible options are the statuses within the task status set.\n You can get a list of statuses within the project’s task status set using the Task Status Set endpoint.\n\nWhen `status` is updated, its `category` is automatically applied to the `state` field of the story."},"checklist":{"type":"array","items":{"type":"string"},"description":"An array of checklist items."},"parent_id":{"type":"integer","format":"int32","description":"Represents the parent of this story, making this a substory."},"archived":{"type":"boolean","description":"Boolean representing whether or not this story is archived."},"assignee_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"An array of user IDs."},"budget_estimate_in_cents":{"type":"integer","format":"int32","description":"Can only be set if the workspace is budgeted and the user has budget permissions."},"time_estimate_in_minutes":{"type":"integer","format":"int32","description":"Can only be set if the workspace is budgeted and the user has budget permissions."},"tag_list":{"type":"string","description":"A comma separated."},"percentage_complete":{"type":"integer","format":"int32","description":"Between 0 and 100. Setting above 0 starts the story and setting to 100 completes the story.."},"fixed_fee":{"type":"boolean","description":"Representing whether the story is fixed fee or not. Can only be set if the workspace is budgeted and the user has budget permissions."},"billable":{"type":"boolean","description":"Representing whether the story is billable or not. Can only be set if the workspace is budgeted and the user has budget permissions."},"weight":{"type":"integer","format":"int32","description":"Representing the weight of the story. Can only be set on a parent-level milestone by a consultant with at least budget permissions."},"priority":{"type":"string","description":"The current priority (importance) of the story (low, normal, high, critical). The default is normal..","enum":["low","normal","high","critical"]},"time_trackable":{"type":"boolean","description":"Whether the story can have time logged against it. Whether this field can be updated and by whom depends on the selections in\n[Time & Expense Settings](https://knowledge.kantata.com/hc/en-us/articles/360000317994-Time-Expense-Settings).\nTime & Expense Settings also determine the default value for new tasks. An Account Administrator can explicitly set this field and override the default for new tasks."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]},"custom_fields":{"type":"array","description":"Determines the custom field values for the task.","items":{"type":"object","properties":{"custom_field_id":{"type":"integer","format":"int32","description":"The ID of the custom field."},"value":{"type":"string","description":"The value for the corresponding custom field. The value formats for different types are:\n\n* `string` - ``, eg. `'foo'`\n* `date` - `` eg. `'2014-02-25'` `(accepted range: '1900-01-01' to '2015-12-31')`\n* `number` - `` eg. `'13'`\n* `currency` - `[, ]` eg. `'[998, USD]'`\n* `single` and `multi` - `[]` eg. `'[1, 2, 4]'`."}}}},"attachment_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"The attachment ids for the files to be associated with the project after its created."},"project_plan":{"type":"boolean","description":"Whether the story is a project task (`true`) or is a To Do (`false`)."}},"required":["workspace_id","title"]}}},"id":"schema_586"},"schema_587":{"kind":"json-schema","data":{"type":"object","properties":{"story":{"type":"object","properties":{"title":{"type":"string","description":"The title cannot be made blank."},"story_type":{"type":"string","description":"Must be 'task', 'deliverable', 'milestone', or 'issue'."},"description":{"type":"string","description":"Must be less than 1000 characters."},"start_date":{"type":"string","format":"date","description":"Projected start date of the project. Format should look like YYYY-MM-DD. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"due_date":{"type":"string","format":"date","description":"Projected end date of the project. Format should look like YYYY-MM-DD. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"state":{"type":"string","description":"The status type (category). It is recommended to set the `status` field instead (which supports custom task statuses).\n\nPossible options depend on the `story_type`:\n - Possible options for `task`, `deliverable`, and `milestone` are `not started`, `started`, `needs info`, and `completed`.\n - If a task status set has not been applied to the workspace, possible options for `issue` are `new`, `reopened`, `in progress`, `blocked`, `fixed`, `duplicate`, `can't repro`, `resolved`, and `won't fix`.\n Otherwise, possible options are `not started`, `started`, `needs info`, and `completed`.\n\nIf both `status` and `state` are provided, the provided `state` value is ignored and the corresponding `category` of the provided `status` is applied to the `state` field instead."},"status":{"type":"string","description":"The status of the story. Possible options depend on whether the workspace has an assigned task status set.\n - If the workspace does not have a task status set assigned, possible options are `not started`, `started`, `needs info`, and `completed`.\n - If the workspace has a task status set assigned, the possible options are the statuses within the task status set.\n You can get a list of statuses within the project’s task status set using the Task Status Set endpoint.\n\nWhen `status` is updated, its `category` is automatically applied to the `state` field of the story."},"follower_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Array of user IDs who are following the story."},"parent_id":{"type":"integer","format":"int32","description":"Represents the parent of this story, making this a substory."},"archived":{"type":"boolean","description":"Boolean representing whether or not this story is archived."},"assignee_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"An array of user IDs."},"budget_estimate_in_cents":{"type":"integer","format":"int32","description":"Can only be set if the workspace is budgeted and the user has budget permissions."},"time_estimate_in_minutes":{"type":"integer","format":"int32","description":"Can only be set if the workspace is budgeted and the user has budget permissions."},"tag_list":{"type":"string","description":"A comma separated."},"percentage_complete":{"type":"integer","format":"int32","description":"Between 0 and 100. Setting above 0 starts the story and setting to 100 completes the story.."},"fixed_fee":{"type":"boolean","description":"Representing whether the story is fixed fee or not. Can only be set if the workspace is budgeted and the user has budget permissions."},"billable":{"type":"boolean","description":"Representing whether the story is billable or not. Can only be set if the workspace is budgeted and the user has budget permissions."},"weight":{"type":"integer","format":"int32","description":"Representing the weight of the story. Can only be set on a parent-level milestone by a consultant with at least budget permissions."},"priority":{"type":"string","description":"The current priority (importance) of the story (low, normal, high, critical). The default is normal.."},"time_trackable":{"type":"boolean","description":"Whether the story can have time logged against it. Whether this field can be updated and by whom depends on the selections in\n[Time & Expense Settings](https://knowledge.kantata.com/hc/en-us/articles/360000317994-Time-Expense-Settings).\nTime & Expense Settings also determine the default value for new tasks. An Account Administrator can explicitly set this field and override the default for new tasks."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]},"custom_fields":{"type":"array","description":"Determines the custom field values for the task.","items":{"type":"object","properties":{"custom_field_id":{"type":"integer","format":"int32","description":"The ID of the custom field."},"value":{"type":"string","description":"The value for the corresponding custom field. The value formats for different types are:\n\n* `string` - ``, eg. `'foo'`\n* `date` - `` eg. `'2014-02-25'` `(accepted range: '1900-01-01' to '2015-12-31')`\n* `number` - `` eg. `'13'`\n* `currency` - `[, ]` eg. `'[998, USD]'`\n* `single` and `multi` - `[]` eg. `'[1, 2, 4]'`."}}}}}}}},"id":"schema_587"},"schema_588":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"story_dependencies":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StoryDependency"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}}}},"id":"schema_588"},"schema_589":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"story_state_changes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StoryStateChange"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}}}},"id":"schema_589"},"schema_590":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"story_tasks":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StoryTask"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}}}},"id":"schema_590"},"schema_591":{"kind":"json-schema","data":{"type":"object","properties":{"story_task":{"type":"object","properties":{"story_id":{"type":"integer","format":"int32","description":"The ID of the associated Story."},"name":{"type":"string","description":"The name of the story task."},"completed":{"type":"boolean","description":"Represents the completion of the story task."},"position":{"type":"integer","format":"int32","description":"The Story Task's position in the list of story tasks."}},"required":["story_id","name"]}}},"id":"schema_591"},"schema_592":{"kind":"json-schema","data":{"type":"object","properties":{"story_task":{"type":"object","properties":{"name":{"type":"string","description":"The name of the story task."},"completed":{"type":"boolean","description":"Represents the completion of the story task."},"position":{"type":"integer","format":"int32","description":"The Story Task's position in the list of story tasks."}}}}},"id":"schema_592"},"schema_593":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"line_item_locks":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/LineItemLock"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}}}},"id":"schema_593"},"schema_594":{"kind":"json-schema","data":{"type":"object","properties":{"line_item_lock":{"type":"object","properties":{"locked_to":{"type":"string","format":"date","description":"Specify the date before which no one on the account will be able to submit or edit time entries.\n(note: This must be a Saturday.) If any Line Item Locks previously existed on your account,\nthis must be set to a later date than said preexisting lock. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."}},"required":["locked_to"]}}},"id":"schema_594"},"schema_595":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["location_id","user_can_edit"]}},"id":"schema_595"},"schema_596":{"kind":"json-schema","data":{"type":"string","default":"date_performed:desc"},"id":"schema_596"},"schema_597":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"time_entries":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TimeEntry"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"stories":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Story"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"timesheet_submissions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TimesheetSubmission"}},"invoices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Invoice"}},"roles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Role"}}}},"id":"schema_597"},"schema_598":{"kind":"json-schema","data":{"type":"object","properties":{"time_entry":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project the time entry is logging work in."},"date_performed":{"type":"string","format":"date","description":"The date the activity for which the time is being entered was performed, format: YYYY-MM-DD. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"time_in_minutes":{"type":"integer","format":"int32","description":"The amount of time in minutes that the activity was worked on."},"billable":{"type":"boolean","description":"Whether this Time Entry is billable time. If you don't provide this parameter, `billable` will be defaulted to the\nvalue of the `billable` flag of its associated `Story` if any, otherwise to true."},"rate_in_cents":{"type":"integer","format":"int32","description":"The hourly rate for the time entry in cents."},"notes":{"type":"string","description":"Any notes added to the time entry. To add line breaks, use `\\n`."},"role_id":{"type":"integer","format":"int32","description":"The ID of the default Role or user assigned Role for the time entry."},"story_id":{"type":"integer","format":"int32","description":"The ID of the task (story) this time entry is associated with."},"user_id":{"type":"integer","format":"int32","description":"This is set to the current_user ID by default. This parameter is ignored unless the authorizing\nuser has financial access in the project and is on the consultants team (or if the authorizing\nuser is an account administrator and has proxy permissions via an account member with\nthose permissions)."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]},"location":{"type":"string","description":"The location of the time entry. Must match the name of an existing account location."}},"required":["workspace_id","date_performed","time_in_minutes"]}}},"id":"schema_598"},"schema_599":{"kind":"json-schema","data":{"type":"object","properties":{"time_entry":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project (workspace) the time entry is logging work in.\nThis can be updated by administrators on the account or users who can edit the time entry\nin the current project and the new project."},"date_performed":{"type":"string","format":"date","description":"The date the activity for which the time is being entered was performed, format: YYYY-MM-DD. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format."},"time_in_minutes":{"type":"integer","format":"int32","description":"The amount of time in minutes that the activity was worked on."},"billable":{"type":"boolean","description":"Whether this Time Entry is billable time. If you don't provide this parameter, `billable` will be defaulted to the\nvalue of the `billable` flag of its associated `Story` if any, otherwise to true."},"rate_in_cents":{"type":"integer","format":"int32","description":"The hourly rate for the time entry in cents."},"notes":{"type":"string","description":"Any notes added to the time entry. To add line breaks, use `\\n`."},"role_id":{"type":"integer","format":"int32","description":"The ID of the default Role or user assigned Role for the time entry."},"story_id":{"type":"integer","format":"int32","description":"The ID of the task (story) this time entry is associated with."},"user_id":{"type":"integer","format":"int32","description":"This sets the entry user for a specified ID. This parameter is ignored unless the authorizing\nuser has financial access in the project and is on the provider team (or if the authorizing\nuser is an account administrator and has proxy permissions via an account member with\nthose permissions)."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]},"location":{"type":"string","description":"The location of the time entry. Must match the name of an existing account location."}}}}},"id":"schema_599"},"schema_600":{"kind":"json-schema","data":{"type":"object","properties":{"resolution":{"type":"object","properties":{"description":{"type":"string","description":"Any additional details about the resolution."},"submission_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"An array of Timesheet Submission IDs that will be processed in this resolution."}},"required":["submission_ids"]}}},"id":"schema_600"},"schema_601":{"kind":"json-schema","data":{"type":"object","properties":{"resolutions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"The ID of the resolution."},"type":{"type":"string","description":"The resolution type, either `approval`, `rejection`, or `cancellation`."},"description":{"type":"string","description":"Additional resolution details."},"target_type":{"type":"string","description":"Whether the resolution is for a timesheet submission or an expense report submission."},"target_id":{"type":"integer","format":"int32","description":"The ID of the associated submission."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user who created the resolution."},"account_id":{"type":"integer","format":"int32","description":"The ID of the account the resolution belongs to."},"current":{"type":"boolean","description":"Indicates if the resolution is outdated or not."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}},"id":"schema_601"},"schema_602":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"page_count":{"type":"integer","format":"int32"},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"}}},"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}}},"timesheet_submissions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TimesheetSubmission"}},"external_references":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalReference"}},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/User"}},"workspaces":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Workspace"}},"time_entries":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TimeEntry"}}}},"id":"schema_602"},"schema_603":{"kind":"json-schema","data":{"type":"object","properties":{"timesheet_submission":{"type":"object","properties":{"line_item_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"An array of time entry IDs of the time entries that will be included in the TimesheetSubmission."},"user_id":{"type":"integer","format":"int32","description":"This can be included when the TimesheetSubmission is being submitted on behalf of another user."},"title":{"type":"string","description":"The title of the TimesheetSubmission."},"workspace_id":{"type":"integer","format":"int32","description":"The ID of the project that will own the TimesheetSubmission and its time entries."},"comment":{"type":"string","description":"Additional notes on the TimesheetSubmission."},"external_reference":{"type":"object","description":"Typically populated programmatically by a third party system via an integration, this is an optional\nobject that holds data from an external system. It connects objects in an external system with objects in\nKantata OX (for example, to connect a Jira issue to a Kantata OX Project).","properties":{"service_name":{"type":"string","description":"The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique."},"service_model":{"type":"string","description":"The object type of the external object this external reference belongs to."},"service_model_ref":{"type":"string","description":"The object ID of the external object this external reference belongs to."},"status":{"type":"string","description":"The status of the integration. Options are `successful`, `pending`, or `failed`."},"external_message":{"type":"string","description":"The message on the external object."},"external_link":{"type":"string","description":"The link to the external object."},"external_status":{"type":"string","description":"The status of the external object in the external system."},"locked":{"type":"boolean","description":"Whether the subject is locked."}},"required":["service_name","service_model","service_model_ref"]}},"required":["line_item_ids","title","workspace_id"]}}},"id":"schema_603"}},"exampleStore":{},"securitySchemeStore":{"BearerToken":{"id":"BearerToken","type":"apiKey","in":"header","paramName":"Bearer"},"OauthSecurity":{"id":"OauthSecurity","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.mavenlink.com/oauth/authorize","tokenUrl":"https://app.mavenlink.com/oauth/token","scopes":{}}}}},"servers":[{"url":"https://api.mavenlink.com/api/v1"}],"logo":{"imageUrl":"https://theme.zdassets.com/theme_assets/56104/04e93064d309f75d054b8cee885d1ea51e9be8f7.png","href":"https://developer.kantata.com","altText":"Kantata OX API Documentation","backgroundColor":"#FFFFFF"}},"options":{"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"Ruby"},{"lang":"JavaScript"},{"lang":"Python"},{"lang":"C#"},{"lang":"Go"}]},"downloadUrls":[{"title":"Download OpenAPI Description","url":"https://app.mavenlink.com/oas/specification"}],"hidePropertiesPrefix":true,"hideReplay":true,"jsonSamplesExpandLevel":5,"maxDisplayedEnumValues":15,"schemasExpansionLevel":0,"sortRequiredPropsFirst":true,"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"url":"/_mock/kantata/specification","position":"off","description":"Mock server"},"disableRouter":true,"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Kantata OX API Documentation","description":"Kantata OX's API provides access to the majority of Kantata OX's data model. The API authenticates requests using OAuth2 tokens and exists primarily to allow scripts and 3rd-party applications to access and manage Kantata OX data on behalf of Kantata OX users.\n\n## Schema\n\nRequests must be sent via HTTPS and can be in either JSON or [Rails structured x-www-form-urlencoded](http://stackoverflow.com/a/950198) format. Responses will always be returned in JSON format. Dates and times are returned as [ISO 8601](http://www.w3.org/TR/NOTE-datetime) formatted strings. All requests to the API must have URLs relative to the base API URL:\n\n\n```\nhttps://api.mavenlink.com/api/v1/\n```\n\n## Authentication\n\nAll requests to the Kantata OX API must be authenticated with an OAuth bearer token. See the application workflow for details on how to register an application with Kantata OX and obtain OAuth bearer tokens.\n\nTo authenticate using the `Authorization` header, set the header's value to `Bearer `. So, if your token was `abc123`, your HTTP request would include the header `Authorization: Bearer abc123`.\n\nFor example, authenticating a request using `curl` would mean running a command similar to this one:\n\n\n```curl\ncurl -H \"Authorization: Bearer abc123\" \"https://api.mavenlink.com/api/v1/workspaces.json\"\n```\n\nAll requests to the Kantata OX API require an Authorization header. For brevity, future API request examples in this documentation will not include the example Authorization header parameter.\n\n### OAuth 2.0\n\n[OAuth 2.0](http://oauth.net/2/) provides an evolving, standardized inter-application authentication workflow for the Web. To build an application that interacts with Kantata OX on behalf of your users, you will need to register your application, and then obtain an OAuth token for each of your users.\n\n#### Registering your application\n\nRegister and manage OAuth2 applications that can connect to Kantata OX at the [application management](https://app.mavenlink.com/oauth/applications) page as a Kantata OX account administrator. You'll need a paid Kantata OX account in order to register applications with us. Applications have a name and a callback URL for OAuth2.\n\nIf you only want to use the Kantata OX API for yourself, or as a backend connector, you must still register an Application, but then you can get an OAuth token for yourself on the Application's page. If you want your application to be able to use the Kantata OX API on behalf of other users, read the next section.\n\n#### Obtaining tokens for users\n\nEvery request to the Kantata OX API must be accompanied by a valid OAuth token, indicating that your application has been authorized by the Kantata OX user in question. When you register an application with us, we'll provide you with a secret key. That key is unique to your application, and shouldn't be shared with anyone else. Treat it like a password. You'll need it to request user tokens.\n\nTo authorize your application for Kantata OX API access and obtain a user token, follow the below steps for each Kantata OX user:\n\nNote: If you are using an OAuth2 library, many of these steps will be handled for you.\n\n 1. Request a short-term code, granted when the Kantata OX user agrees to allow your application access.\n\n Send your user to `/oauth/authorize` with the REQUIRED parameters `client_id`, `response_type`, and `redirect_uri`.\n\n * `client_id` is the ID assigned to your application by Kantata OX\n * `response_type` must be set to \"code\"\n * `redirect_uri` must be set to a URL where your application can accept codes and then exchange them for access tokens. It should match the `redirect_uri` specified when you registered your application.\n\n Here is an example URL that an application located at \"myapp.com\" might use. (Linebreaks are not included in the URL.)\n\n ```curl\n https://app.mavenlink.com/oauth/authorize?response_type=code&client_id=abc123&redirect_uri=http%3A%2F%2Fmyapp.com%2Foauth%2Fcallback\n ```\n\n 2. The user will be asked by Kantata OX if they want to authorize your application to interact with Kantata OX on their behalf.\n\n If something goes wrong (like the user refused to authorize your application), Kantata OX will redirect to the `redirect_uri` with query parameters providing information about the error. For example, if authorization is denied, the user will be redirected to:\n\n ```curl\n $REDIRECT_URI?error=access_denied&error_description=The+resource+owner+or+authorization+server+denied+the+request.\n ```\n\n If the user allows your application, then Kantata OX will redirect to the `redirect_uri` with query parameters providing your application with a time-limited code that your application can exchange for an access token within the next 5 minutes. Here is an example redirection with granted access:\n\n ```curl\n $REDIRECT_URI?code=abc123\n ```\n\n 3. Your application exchanges the code for an access token\n\n Now that your application has a code, it should make a POST request directly to Kantata OX at `https://app.mavenlink.com/oauth/token` to exchange the code for an access token that will allow continued interaction with the Kantata OX API. The request must include the `client_id`, `client_secret`, `grant_type`, `code`, and `redirect_uri` parameters.\n\n * `client_id` is the ID assigned to your application by Kantata OX\n * `client_secret` is the secret token assigned to your application by Kantata OX\n * `grant_type` must be set to \"authorization_code\" in order to exchange a code for an access token\n * `code` is the value that was returned in the `code` query parameter when Kantata OX redirected back to your `redirect_uri`\n * `redirect_uri` is the exact same value that you used in the original request to /oauth/authorize\n\n If the request is invalid for some reason, an error response like the one described above will be returned. However, the parameters will be returned in the response body, encoded as JSON, instead of in the URL encoded as query parameters.\n\n If the request is valid, Kantata OX will provide a response body, encoded in JSON, containing `access_token` and `token_type`.\n\n * `access_token` is the token that your application will use to authenticate requests to the Kantata OX API as this user\n * `token_type` will be \"bearer\"\n\n 4. Your application uses the access token to make authenticated requests to the Kantata OX API\n\n At this point, your application can use the access token to authenticate requests made to the Kantata OX API as described above in the [Authentication](#authentication) section.\n\n## Bearer Token\n**Security Scheme Type:** API Key\n\n**Header parameter name:** Bearer\n\n## OauthSecurity\n**Security Scheme Type:** OAuth2\n\n**Flow type:** `authorizationCode`\n\n**Authorization URL:** `https://app.mavenlink.com/oauth/authorize`\n\n**Token URL:** `https://app.mavenlink.com/oauth/token`\n\n### Security\n\nKantata OX OAuth access tokens do not expire and must be treated with the same security that you would treat client credentials such as passwords. All requests must be made over SSL and all user security credentials must be stored using industry best practices. If a user revokes your application's access, usage of the token will result in an error.\n\n## Response Format\n\nKantata OX API responses come back as JSON. All GET responses will be of a format similar to the following:\n\n\n```json\n{\n \"count\": 2,\n \"results\": [{ key: \"workspaces\", id: \"10\" }, { key: \"workspaces\", id: \"11\" }],\n \"workspaces\": {\n \"10\": {\n id: \"10\",\n title: \"some project\",\n participant_ids: [\"2\", \"6\"],\n primary_counterpart_id: \"6\"\n },\n \"11\": {\n id: \"11\",\n title: \"another project\",\n participant_ids: [\"2\", \"8\"],\n primary_counterpart_id: \"8\"\n }\n },\n \"users\": {\n \"2\": { id: \"2\", full_name: \"bob\" },\n \"6\": { id: \"6\", full_name: \"chaz\" },\n \"8\": { id: \"8\", full_name: \"jane\" }\n }\n}\n```\n\nAs you can see, Kantata OX API responses can return multiple data types simultaneously, transferring objects and their associations in a single response. In this example, the developer has likely requested the `/workspaces.json` endpoint, asking for inclusion of those workspaces' participants and primary counterparts. These associations have come back in the top-level object called `users`. The developer should always use the returned `results` array to retrieve the canonical results from an API request. This is because some objects may have associations of the same type and can thus be mixed together with their associations in the JSON. For example, stories (tasks) have sub_stories which are the same type of object, so looking directly at the returned `stories` key when stories have been requested to include their sub_stories will be confusing and will include both. Instead, iterate the `results` key to determine exactly which top-level objects matched your query and in what order.\n\nThe follow sections explain how to customize further the Kantata OX API responses to your needs.\n\n## Pagination\n\nLarge lists of items may be returned in pages. The JSON response will contain a key named `count` with a value of the number of objects returned by the entire query. If that number is greater than the number of objects returned by the request, additional objects may be requested by setting the parameter `page`, the parameter `per_page`, or both.\n\nIf you would like to start at a specific offset you may alternatively use `limit` and `offset` parameters. If both `limit` and `offset` are passed then `page` and `per_page` are ignored, otherwise behavior falls back to `page` and `per_page`.\n\n* `page`\n * type: Integer\n * default: 1\n* `per_page`\n * type: Integer\n * default: 20\n * maximum: 200\n* `usage`\n * workspaces.json?page=2&per_page=15\n\n-or-\n\n* `limit`\n * type: Integer\n * minimum: 1\n* `offset`\n * type: Integer\n * minimum: 0\n* `usage`\n * workspaces.json?limit=15&offset=10\n\n## Request by ID\n\nWhile each API endpoint returns a paginated listing of the data available, it is sometimes more useful to request only one (or only a few) items. The Kantata OX API provides two ways to do this. The first, via the `only` parameter, allows you to request one or more resources directly by ID. To request the data for a single Workspace with an ID of 5, make an API request to the URL `GET /api/v1/workspaces.json?only=5`. Multiple IDs can be supplied in a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`. The returned JSON will contain only the objects with those IDs.\n\n* `only`\n * type: Comma separated Integers\n * default: not applicable\n* `usage`\n * workspaces.json?only=5,6\n\nAdditionally, we support traditional RESTful routes, such as `GET /api/v1/workspaces/5.json`. These routes also support our standard filters and includes, both detailed below. Unlike `only` requests to our \"index\" routes, these \"show\" routes will generate a 404 response if the requested resource cannot be found. Sometimes this is due to default filters being applied, so be sure to check the filter defaults applied in the specific documentation for the requested resource. More on filters below.\n\n## Filters\n\nMany API endpoints also provide an optional set of filters that can be applied to the data that will be returned. Each filter, and the logic behind it, is documented on the individual endpoint pages, but the general form is a URL query parameter or request parameter like `filter1=arg1&filter2=arg2`, where `filter1` and `filter2` are the names of two different filters, and `arg1` and `arg2` are the arguments to each filter, respectively. Additionally, some filters have default values, which indicates that they are automatically applied to your request with their default value. Default values are applied both on \"index\" (`GET /workspaces.json`) requests and \"show\" (`GET /workspaces/1.json`) requests.\n\n## Includes\n\nSome objects returned by the API may have associations that are not included in the JSON response by default. Those associated objects can be requested by adding an `include` parameter to the request. For example, to request both a list of posts, and the users that created those posts, you could request `/posts.json?include=user`. The response will consist of a JSON object with an array of result mappings under the `\"results\"` key, a `\"posts\"` key with a hash of post objects, keyed by id, and a `\"users\"` key with a hash of user objects, again keyed by id. To find the user that created a particular post, just use the post object's `\"user_id\"` key to find the user object keyed with the same id.\n\nMultiple associations may be fetched simultaneously by adding comma-separated values to the `include` parameter. For example, to fetch the user and replies associated with post 6, you might request `/posts.json?only=6&include=user,attachments`, which would supply both the users and the attachments that belong to the posts returned in the response.\n\n_Example_\n\n\n```curl\ncurl -H \"Authorization: Bearer abc123\" \"https://api.mavenlink.com/api/v1/posts.json?include=user,attachments\"\n```\n\n```json\n{\n \"count\": 1,\n \"results\": [\n { \"key\": \"posts\", \"id\": \"16270634\" }\n ],\n \"posts\": {\n \"16270634\": {\n \"id\": \"16270634\",\n \"message\": \"Hello World\",\n \"has_attachments\": true,\n \"user_id\": \"2\",\n \"workspace_id\": \"2249167\",\n \"attachment_ids\": [\"6700107\"]\n }\n },\n \"users\": {\n \"2\": {\n \"id\": \"2\",\n \"full_name\": \"John Doe\",\n \"email_address\": \"johnny_doe@example.com\"\n }\n },\n \"attachments\": {\n \"6700107\": {\n \"id\": \"6700107\",\n \"created_at\": \"2013-04-15T16:48:48-07:00\",\n \"filename\": \"turtle.jpg\",\n \"filesize\": 16225\n }\n }\n}\n```\n\n## Optional Fields\n\nSome objects returned by the API may have fields that are not included in the JSON response by default. Those optional fields can be requested by adding an `optional_fields` parameter to the request. For example, to request a list of stories and include the optional field `can_edit`, you could request `/stories.json?optional_fields=can_edit`. Each story in the response will include the requested optional field in their JSON.\n\nMultiple optional fields may be requested simultaneously by adding comma-separated values to the `optional_fields` parameter. For example, to fetch stories and include both `can_edit` and `can_post` fields in the response, you can request `/stories.json?optional_fields=can_edit,can_post`.\n\n_Example_\n\n\n```curl\ncurl -H \"Authorization: Bearer abc123\" \"https://api.mavenlink.com/api/v1/stories.json?optional_fields=can_edit,can_post\"\n```\n\n```json\n{\n \"count\": 1,\n \"results\": [\n {\n \"key\": \"stories\",\n \"id\": \"1941361\"\n }\n ],\n \"stories\": {\n \"1937928\": {\n \"title\": \"Example Story\",\n \"description\": \"example description\",\n ...\n \"subtree_depth\": 0,\n \"ancestry_depth\": 0,\n \"can_edit\": true,\n \"can_post\": true,\n \"time_trackable\": true,\n \"time_estimate_in_minutes\": null,\n ...\n \"parent_id\": null,\n \"root_id\": null,\n \"id\": \"1937928\"\n }\n },\n \"meta\": {\n \"count\": 1,\n \"page_count\": 1,\n \"page_number\": 1,\n \"page_size\": 20\n }\n}\n```\n\n## Ordering\n\nEach endpoint in the Kantata OX API allows ordering by various fields. If we're missing a sort field that you need, please ask! See the specific endpoint documentation for endpoint-specific details.\n\nWhen ordering, supply `order` with the name of a valid sort field for the endpoint and a direction. For example, `order=created_at:desc`.\n\n## Searching\n\nSome API endpoints support text search, however only some filters can be combined with search, and results will be returned ordered by relevancy to the search query. Search does not apply to `only` requests. If search is unavailable the response will contain a system error describing the problem.\n\nTo make a search request, simply add a `search` parameter to the request. For example, to search for stories with \"estimates\" in the title, assignee names, or other fields, request `/stories.json?search=estimates`\n\n## Errors\n\nIf there is an error while processing your request, the response will include an HTTP status code indicating the error. Errors are currently returned as a top-level `errors` key with an array of error objects. For example, on OAuth failure you will receive a HTTP 401 with the following JSON body:\n \n\n```json\n{\n errors: [\n {\n type: \"oauth\"\n message: \"Invalid OAuth 2 Request\"\n }\n ]\n}\n```\n\nSystem errors will look like:\n\n\n```json\n{\n errors: [\n {\n type: \"system\"\n message: \"Your account has been canceled\"\n }\n ]\n}\n```\n\nAnd model validation errors look like:\n\n\n```json\n{\n errors: [\n {\n type: \"validation\",\n message: \"Please give your project a title\",\n field: \"title\"\n },\n {\n type: \"validation\",\n message: \"Please select a role for this project\",\n field: \"creator_role\"\n }\n ]\n}\n```\n\n\n## Rate Limits\n\nWhen too many requests are made in a short amount of time, the API may reply with the HTTP code 429 Too Many Requests. In that case, simply retry your request after a small delay.\n\nThere are general rate limits applied to all requests. The following endpoints also have their own rate limits:\n\n* [Create a workspace](/tag/Workspaces#operation/create-workspace) - `POST /api/v1/workspaces`\n* [Get workspaces](/tag/Workspaces#operation/get-workspaces) - `GET /api/v1/workspaces`\n* [Create a workspace invitation](/tag/Workspaces#operation/create-workspace-invitation) - `POST /api/v1/workspaces/{id}/invite`\n* [Create an account invitation](/tag/Account-Invitations#operation/create-account-invitation) (i.e. Create a new user) - `POST /api/v1/account_invitations`\n* [Resend an account invitation](/tag/Account-Invitations#operation/resend-account-invitation) - `PUT /api/v1/account_invitations/{id}/resend`\n* [Create custom field value](/tag/Custom-Field-Values#operation/create-custom-field-value) - `POST /api/v1/custom_field_values`\n* [Get custom field values](/tag/Custom-Field-Values#operation/get-custom-field-values) - `GET /api/v1/custom_field_values`\n* [Create a project snapshot](/tag/Project-Snapshots#operation/create-project-snapshot) - `POST /api/v1/project_snapshots`\n\nPlease see the [Knowledge Base](https://knowledge.kantata.com/hc/en-us/articles/9698066628123) for the exact rate limits.\n\nPlease note that we reserve the right to change the limits at any time. In addition, if we determine that someone is using the API improperly, we may adjust the limits further.\n\n## Timeouts\n\nAll API requests will timeout after 3 minutes. Timeouts typically occur when there is a lot of data to return. You can use the following strategies to avoid your requests timing out:\n\n* Break up your request into smaller requests\n* Apply a date filter to your request\n* If you are polling multiple endpoints in order to export data or sync Kantata data to a third-party system, use the [Subscribed Events API](/tag/Events) instead. You can get recently updated objects in one request.\n"}},"baseSlug":"/kantata/specification","routesMapping":{}}