{"items":[{"type":"link","label":"Custom Field API","link":"/openapi/customfieldapi","routeSlug":"/openapi/customfieldapi","content":{"contentType":"overview","meta":{"name":"Custom Field API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"CustomFieldApi.json","url":"/_bundle/openapi/CustomFieldApi.json?download"},{"kind":"download","label":"CustomFieldApi.yaml","url":"/_bundle/openapi/CustomFieldApi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Custom Field API (v3)","showPageActions":true}],"sectionId":"/openapi/customfieldapi"}]}]}},{"type":"group","label":"Custom Field V3","link":"/openapi/customfieldapi/custom-field-v3","routeSlug":"/openapi/customfieldapi/custom-field-v3","items":[{"label":"Reorder custom fields","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/reordercustomfields","routeSlug":"/openapi/customfieldapi/custom-field-v3/reordercustomfields","metadata":{"seo":{"title":"Reorder custom fields","description":"Reorder custom fields"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reorderCustomFields","name":"Reorder custom fields","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1reorder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reorder custom fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1reorder/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReorderCustomFieldsRequest"}},"schemaId":"components/schemas/ReorderCustomFieldsRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1reorder/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/custom-fields/reorder","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReorderCustomFieldsRequest"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/reorder","href":"custom-field-v3/reordercustomfields","openApiOperationId":"reorderCustomFields","summary":"Reorder custom fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/ReorderCustomFieldsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReorderCustomFieldsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1reorder/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/reorder"},{"label":"Update custom field status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/updatecustomfieldstatus","routeSlug":"/openapi/customfieldapi/custom-field-v3/updatecustomfieldstatus","metadata":{"seo":{"title":"Update custom field status","description":"Update custom field status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomFieldStatus","name":"Update custom field status","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1update-status/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update custom field status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1update-status/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"companyRole","in":"query","schemaId":"schema_1","required":true,"example":"ORG"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1update-status/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomFieldStatusRequest"}},"schemaId":"components/schemas/UpdateCustomFieldStatusRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1update-status/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/companies/{companyId}/custom-fields/update-status","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[{"name":"companyRole","in":"query","required":true,"example":"ORG","schemaId":"components/schemas/CompanyRole"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCustomFieldStatusRequest"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/update-status","href":"custom-field-v3/updatecustomfieldstatus","openApiOperationId":"updateCustomFieldStatus","summary":"Update custom field status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateCustomFieldStatusRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomFieldStatusRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1update-status/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/update-status"},{"label":"Create custom field","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/createcustomfieldv3","routeSlug":"/openapi/customfieldapi/custom-field-v3/createcustomfieldv3","metadata":{"seo":{"title":"Create custom field","description":"This endpoint creates a custom field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomFieldV3","name":"Create custom field","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint creates a custom field."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"companyRole","in":"query","schemaId":"schema_1","required":true,"example":"ORG"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCustomFieldRequestV3"}},"schemaId":"components/schemas/CreateCustomFieldRequestV3","pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/custom-fields","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[{"name":"companyRole","in":"query","required":true,"example":"ORG","schemaId":"components/schemas/CompanyRole"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCustomFieldRequestV3"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/companies/{companyId}/custom-fields","href":"custom-field-v3/createcustomfieldv3","openApiOperationId":"createCustomFieldV3","summary":"Create custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/CreateCustomFieldRequestV3","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCustomFieldRequestV3"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityId"}},"schemaId":"components/schemas/EntityId"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityId"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields"},{"label":"Update custom field","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/updatecustomfieldv3","routeSlug":"/openapi/customfieldapi/custom-field-v3/updatecustomfieldv3","metadata":{"seo":{"title":"Update custom field","description":"This endpoint updates a custom field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomFieldV3","name":"Update custom field","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint updates a custom field."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"customFieldId","in":"path","schemaId":"schema_0","description":"Identifier for custom field.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomFieldV3"}},"schemaId":"components/schemas/CustomFieldV3","pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/companies/{companyId}/custom-fields/{customFieldId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"customFieldId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomFieldV3"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/{customFieldId}","href":"custom-field-v3/updatecustomfieldv3","openApiOperationId":"updateCustomFieldV3","summary":"Update custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/CustomFieldV3","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomFieldV3"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Successfully"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/{customFieldId}"},{"label":"Get custom field","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/readcustomfieldv3","routeSlug":"/openapi/customfieldapi/custom-field-v3/readcustomfieldv3","metadata":{"seo":{"title":"Get custom field","description":"This endpoint gets a custom field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"readCustomFieldV3","name":"Get custom field","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint gets a custom field."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"customFieldId","in":"path","schemaId":"schema_0","description":"Identifier for custom field.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/companies/{companyId}/custom-fields/{customFieldId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"customFieldId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/{customFieldId}","href":"custom-field-v3/readcustomfieldv3","openApiOperationId":"readCustomFieldV3","summary":"Get custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldV3"}},"schemaId":"components/schemas/CustomFieldV3"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomFieldV3","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldV3"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/{customFieldId}"},{"label":"Delete custom field","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/deletecustomfieldv3","routeSlug":"/openapi/customfieldapi/custom-field-v3/deletecustomfieldv3","metadata":{"seo":{"title":"Delete custom field","description":"This endpoint deletes a custom field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomFieldV3","name":"Delete custom field","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint deletes a custom field."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"customFieldId","in":"path","schemaId":"schema_0","description":"Identifier for custom field.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/companies/{companyId}/custom-fields/{customFieldId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"customFieldId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/{customFieldId}","href":"custom-field-v3/deletecustomfieldv3","openApiOperationId":"deleteCustomFieldV3","summary":"Delete custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deleted Successfully"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/{customFieldId}"},{"label":"List custom field","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/listcustomfieldv3","routeSlug":"/openapi/customfieldapi/custom-field-v3/listcustomfieldv3","metadata":{"seo":{"title":"List custom field","description":"List custom field"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomFieldV3","name":"List custom field","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1list/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"companyRole","in":"query","schemaId":"schema_1","required":true,"example":"ORG"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListCustomFieldRequestV3"}},"schemaId":"components/schemas/ListCustomFieldRequestV3","pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/custom-fields/list","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[{"name":"companyRole","in":"query","required":true,"example":"ORG","schemaId":"components/schemas/CompanyRole"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ListCustomFieldRequestV3"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/list","href":"custom-field-v3/listcustomfieldv3","openApiOperationId":"listCustomFieldV3","summary":"List custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/ListCustomFieldRequestV3","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListCustomFieldRequestV3"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCustomFieldResponseV3"}},"schemaId":"components/schemas/ListCustomFieldResponseV3"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1list/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCustomFieldResponseV3","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCustomFieldResponseV3"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/list"},{"label":"Update option for the given options group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/updatecustomfieldoptiongroupv3","routeSlug":"/openapi/customfieldapi/custom-field-v3/updatecustomfieldoptiongroupv3","metadata":{"seo":{"title":"Update option for the given options group","description":"Updates (replaces) all the options of the given group with the provided ones."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomFieldOptionGroupV3","name":"Update option for the given options group","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1option-groups~1{optionGroupId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update option for the given options group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates (replaces) all the options of the given group with the provided ones."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"customFieldId","in":"path","schemaId":"schema_0","description":"Identifier for custom field.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"optionGroupId","in":"path","schemaId":"schema_0","description":"Identifier for the options group","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1option-groups~1{optionGroupId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomFieldOptionGroupRequestV3"}},"schemaId":"components/schemas/UpdateCustomFieldOptionGroupRequestV3","pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1option-groups~1{optionGroupId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/companies/{companyId}/custom-fields/{customFieldId}/option-groups/{optionGroupId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"customFieldId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"optionGroupId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCustomFieldOptionGroupRequestV3"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/{customFieldId}/option-groups/{optionGroupId}","href":"custom-field-v3/updatecustomfieldoptiongroupv3","openApiOperationId":"updateCustomFieldOptionGroupV3","summary":"Update option for the given options group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateCustomFieldOptionGroupRequestV3","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomFieldOptionGroupRequestV3"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Successfully"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1option-groups~1{optionGroupId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/{customFieldId}/option-groups/{optionGroupId}"},{"label":"Upload file of options to be processed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/bulkuploadoptions","routeSlug":"/openapi/customfieldapi/custom-field-v3/bulkuploadoptions","metadata":{"seo":{"title":"Upload file of options to be processed","description":"Upload file of options to be processed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkUploadOptions","name":"Upload file of options to be processed","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1option-groups~1{optionGroupId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload file of options to be processed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"customFieldId","in":"path","schemaId":"schema_0","description":"Identifier for custom field.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"optionGroupId","in":"path","schemaId":"schema_0","description":"Identifier for the options group","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1option-groups~1{optionGroupId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_2"}},"schemaId":"schema_2","pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1option-groups~1{optionGroupId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/custom-fields/{customFieldId}/option-groups/{optionGroupId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"customFieldId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"optionGroupId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_2"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/{customFieldId}/option-groups/{optionGroupId}","href":"custom-field-v3/bulkuploadoptions","openApiOperationId":"bulkUploadOptions","summary":"Upload file of options to be processed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"schema_2","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkUploadResponse"}},"schemaId":"components/schemas/BulkUploadResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1option-groups~1{optionGroupId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkUploadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkUploadResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/{customFieldId}/option-groups/{optionGroupId}"},{"label":"Create custom field arm","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/createarm","routeSlug":"/openapi/customfieldapi/custom-field-v3/createarm","metadata":{"seo":{"title":"Create custom field arm","description":"This endpoint creates a custom field arm."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createArm","name":"Create custom field arm","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create custom field arm","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint creates a custom field arm."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"customFieldId","in":"path","schemaId":"schema_0","description":"Identifier for custom field.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateArmRequest"}},"schemaId":"components/schemas/CreateArmRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"customFieldId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateArmRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms","href":"custom-field-v3/createarm","openApiOperationId":"createArm","summary":"Create custom field arm"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/CreateArmRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateArmRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateArmResponse"}},"schemaId":"components/schemas/CreateArmResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateArmResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateArmResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms"},{"label":"Update arm","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/updatearm","routeSlug":"/openapi/customfieldapi/custom-field-v3/updatearm","metadata":{"seo":{"title":"Update arm","description":"This endpoint updates an arm."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateArm","name":"Update arm","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update arm","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint updates an arm."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"customFieldId","in":"path","schemaId":"schema_0","description":"Identifier for custom field.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"armId","in":"path","schemaId":"schema_0","description":"Identifier for arm.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Arm"}},"schemaId":"components/schemas/Arm","pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"customFieldId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"armId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Arm"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}","href":"custom-field-v3/updatearm","openApiOperationId":"updateArm","summary":"Update arm"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/Arm","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Arm"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Successfully"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}"},{"label":"Get arm","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/getarm","routeSlug":"/openapi/customfieldapi/custom-field-v3/getarm","metadata":{"seo":{"title":"Get arm","description":"This endpoint gets an arm."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getArm","name":"Get arm","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get arm","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint gets an arm."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"customFieldId","in":"path","schemaId":"schema_0","description":"Identifier for custom field.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"armId","in":"path","schemaId":"schema_0","description":"Identifier for arm.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"customFieldId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"armId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}","href":"custom-field-v3/getarm","openApiOperationId":"getArm","summary":"Get arm"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Arm"}},"schemaId":"components/schemas/Arm"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Arm","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Arm"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}"},{"label":"Delete arm","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/deletearm","routeSlug":"/openapi/customfieldapi/custom-field-v3/deletearm","metadata":{"seo":{"title":"Delete arm","description":"This endpoint deletes an arm."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteArm","name":"Delete arm","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete arm","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint deletes an arm."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"customFieldId","in":"path","schemaId":"schema_0","description":"Identifier for custom field.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"armId","in":"path","schemaId":"schema_0","description":"Identifier for arm.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"customFieldId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"armId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}","href":"custom-field-v3/deletearm","openApiOperationId":"deleteArm","summary":"Delete arm"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deleted Successfully"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}"},{"label":"List arms","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/listarms","routeSlug":"/openapi/customfieldapi/custom-field-v3/listarms","metadata":{"seo":{"title":"List arms","description":"List arms"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listArms","name":"List arms","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List arms","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"customFieldId","in":"path","schemaId":"schema_0","description":"Identifier for custom field.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListArmsRequest"}},"schemaId":"components/schemas/ListArmsRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/list","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"customFieldId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ListArmsRequest"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/list","href":"custom-field-v3/listarms","openApiOperationId":"listArms","summary":"List arms"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/ListArmsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListArmsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListArmsResponse"}},"schemaId":"components/schemas/ListArmsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1list/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListArmsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListArmsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/list"},{"label":"Get options for a custom field.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/getcustomfieldv3optionlist","routeSlug":"/openapi/customfieldapi/custom-field-v3/getcustomfieldv3optionlist","metadata":{"seo":{"title":"Get options for a custom field.","description":"Get options for a custom field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomFieldV3OptionList","name":"Get options for a custom field.","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}~1option-list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get options for a custom field.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier for company.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"customFieldId","in":"path","schemaId":"schema_0","description":"Identifier for custom field.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"},{"name":"armId","in":"path","schemaId":"schema_0","description":"Identifier for arm.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}~1option-list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetCustomFieldOptionListRequestV3"}},"schemaId":"components/schemas/GetCustomFieldOptionListRequestV3","pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}~1option-list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}/option-list","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"customFieldId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"},{"name":"armId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetCustomFieldOptionListRequestV3"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}/option-list","href":"custom-field-v3/getcustomfieldv3optionlist","openApiOperationId":"getCustomFieldV3OptionList","summary":"Get options for a custom field."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/GetCustomFieldOptionListRequestV3","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetCustomFieldOptionListRequestV3"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCustomFieldOptionListResponseV3"}},"schemaId":"components/schemas/GetCustomFieldOptionListResponseV3"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1custom-fields~1{customFieldId}~1arms~1{armId}~1option-list/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCustomFieldOptionListResponseV3","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCustomFieldOptionListResponseV3"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}/option-list"},{"label":"Get applicable custom fields","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfieldapi/custom-field-v3/getapplicablecustomfields","routeSlug":"/openapi/customfieldapi/custom-field-v3/getapplicablecustomfields","metadata":{"seo":{"title":"Get applicable custom fields","description":"Get applicable custom fields"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplicableCustomFields","name":"Get applicable custom fields","isWebhook":false,"pointer":"/paths/~1v3~1applicable-custom-fields/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get applicable custom fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetApplicableCustomFieldsRequest"}},"schemaId":"components/schemas/GetApplicableCustomFieldsRequest","pointer":"/paths/~1v3~1applicable-custom-fields/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/applicable-custom-fields","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetApplicableCustomFieldsRequest"}},"responseCodes":["200","401","403","404"],"pointer":"/v3/applicable-custom-fields","href":"custom-field-v3/getapplicablecustomfields","openApiOperationId":"getApplicableCustomFields","summary":"Get applicable custom fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/GetApplicableCustomFieldsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetApplicableCustomFieldsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetApplicableCustomFieldsResponse"}},"schemaId":"components/schemas/GetApplicableCustomFieldsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1applicable-custom-fields/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetApplicableCustomFieldsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetApplicableCustomFieldsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/applicable-custom-fields"}],"content":{"contentType":"group","meta":{"name":"Custom Field V3"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Field V3","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage company custom fields."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/companies/{companyId}/custom-fields/reorder","summary":"Reorder custom fields","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-field-v3/reordercustomfields","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/update-status","summary":"Update custom field status","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom-field-v3/updatecustomfieldstatus","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields","summary":"Create custom field","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-field-v3/createcustomfieldv3","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/{customFieldId}","summary":"Update custom field","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-field-v3/updatecustomfieldv3","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/{customFieldId}","summary":"Get custom field","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-field-v3/readcustomfieldv3","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/{customFieldId}","summary":"Delete custom field","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-field-v3/deletecustomfieldv3","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/list","summary":"List custom field","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-field-v3/listcustomfieldv3","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/{customFieldId}/option-groups/{optionGroupId}","summary":"Update option for the given options group","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom-field-v3/updatecustomfieldoptiongroupv3","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/{customFieldId}/option-groups/{optionGroupId}","summary":"Upload file of options to be processed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-field-v3/bulkuploadoptions","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms","summary":"Create custom field arm","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-field-v3/createarm","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}","summary":"Update arm","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-field-v3/updatearm","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}","summary":"Get arm","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-field-v3/getarm","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}","summary":"Delete arm","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-field-v3/deletearm","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/list","summary":"List arms","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-field-v3/listarms","deprecated":false},{"title":"/v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}/option-list","summary":"Get options for a custom field.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-field-v3/getcustomfieldv3optionlist","deprecated":false},{"title":"/v3/applicable-custom-fields","summary":"Get applicable custom fields","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-field-v3/getapplicablecustomfields","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AdditionalInfo":{"id":"components/schemas/AdditionalInfo","kind":"json-schema","title":"AdditionalInfo","data":{"type":"object","title":"AdditionalInfo","description":"Additional data need to be sent along with the custom field response.","discriminator":{"propertyName":"type","mapping":{"VARIABLE":"#/components/schemas/Variable","EXPRESSION":"#/components/schemas/Expression"}},"oneOf":[{"$ref":"#/components/schemas/Variable"},{"$ref":"#/components/schemas/Expression"}]}},"components/schemas/AirItineraryContext":{"id":"components/schemas/AirItineraryContext","kind":"json-schema","title":"AirItineraryContext","data":{"type":"object","title":"AirItineraryContext","description":"Air Itinerary Context","required":["itineraryType","searchId","rateOptionId"],"properties":{"itineraryType":{"type":"string","description":"Type of itinerary","default":"AIR"},"searchId":{"type":"string","description":"The search key related to booking"},"rateOptionId":{"type":"string","description":"The 'id' of the selected itinerary in the air search response"}}}},"components/schemas/AnyPolicyPredicate":{"id":"components/schemas/AnyPolicyPredicate","kind":"json-schema","title":"AnyViolationPredicate","data":{"type":"object","title":"AnyViolationPredicate","description":"Any policy.","required":["type"],"properties":{"type":{"type":"string","example":"ANY_POLICY","default":"ANY_POLICY"}}}},"components/schemas/ApplicableCustomFieldV3":{"id":"components/schemas/ApplicableCustomFieldV3","kind":"json-schema","title":"ApplicableCustomFieldV3","data":{"type":"object","title":"ApplicableCustomFieldV3","description":"Applicable Custom field.","required":["id","name","armId","action"],"properties":{"id":{"type":"string","format":"uuid","description":"Custom field id.","readOnly":true},"name":{"type":"string","description":"Name of this field to be viewed by the user and consumed by downstream service.\n","example":"Air Reason Code"},"translatedName":{"type":"string","description":"Name of this field to be viewed by the user, translated to their preferred language.\n","example":"Air Reason Code"},"armId":{"type":"string","format":"uuid","description":"Arm id which is applicable.","example":"f49d00fe-1eda-4304-ba79-a980f565281d"},"description":{"$ref":"#/components/schemas/DisplayText"},"includeLocations":{"type":"array","items":{"$ref":"#/components/schemas/IncludeLocation"}},"action":{"description":"Action available for the custom field.","$ref":"#/components/schemas/CustomFieldAction"}}}},"components/schemas/Arm":{"id":"components/schemas/Arm","kind":"json-schema","title":"Arm","data":{"type":"object","title":"Arm","description":"A set of audiences along with their corresponding action.","required":["action","name"],"properties":{"id":{"type":"string","format":"uuid","description":"Arm id."},"name":{"type":"string","description":"Name of the arm.","example":"US Employee"},"audiences":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldAudience"},"default":[]},"action":{"$ref":"#/components/schemas/CustomFieldAction"}}}},"components/schemas/AutoOption":{"id":"components/schemas/AutoOption","kind":"json-schema","title":"AutoOption","data":{"type":"object","title":"AutoOption","description":"An item representing a auto selectable code for a custom field.","required":["name","type"],"properties":{"type":{"type":"string","example":"AUTO","default":"AUTO"},"hidden":{"type":"boolean","description":"Whether this code will be hidden to the user.","example":true,"default":false},"description":{"type":"string","description":"Description of the code.","example":"Lower fare declined"},"name":{"type":"string","description":"Code which represents the auto selected option for the custom field.","example":"LD"},"additionalInfos":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalInfo"},"default":[]}}}},"components/schemas/BookingContext":{"id":"components/schemas/BookingContext","kind":"json-schema","title":"BookingContext","data":{"type":"object","title":"BookingContext","description":"Booking context for given booking flow.","required":["tripId","itinerary"],"properties":{"tripId":{"type":"string","description":"Identifier of the trip"},"itinerary":{"$ref":"#/components/schemas/ItineraryContext"},"bookingFlowType":{"$ref":"#/components/schemas/BookingFlowTypeV3"},"paymentSourceIds":{"type":"array","items":{"type":"string"}},"pnrCreationProcessType":{"$ref":"#/components/schemas/CreatedVia","default":"OBT"},"inlineQCFailureRules":{"description":"A list of failed inline QC rules","type":"array","items":{"$ref":"#/components/schemas/InlineQCFailureRule"}}}}},"components/schemas/BookingFlowTypeV3":{"id":"components/schemas/BookingFlowTypeV3","kind":"json-schema","title":"BookingFlowType","data":{"type":"string","title":"BookingFlowType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the booking flow stage—such as creating, modifying, or canceling a booking."},"children":[]}]}]}],"enum":["NEW_BOOKING","MODIFY_BOOKING","CANCEL_BOOKING"],"example":"NEW_BOOKING"}},"components/schemas/BookingFlowTypeV3Predicate":{"id":"components/schemas/BookingFlowTypeV3Predicate","kind":"json-schema","title":"BookingFlowTypeV3Predicate","data":{"type":"object","title":"BookingFlowTypeV3Predicate","description":"Compare the booking flow type with the values.","required":["type","comparator","bookingFlowTypes"],"properties":{"type":{"type":"string","default":"BOOKING_FLOW_TYPE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"bookingFlowTypes":{"type":"array","description":"List of booking flow types to compare.","minItems":1,"items":{"$ref":"#/components/schemas/BookingFlowTypeV3"}}}}},"components/schemas/BookingInitiatorTypePredicate":{"id":"components/schemas/BookingInitiatorTypePredicate","kind":"json-schema","title":"BookingInitiatorTypePredicate","data":{"type":"object","title":"BookingInitiatorTypePredicate","description":"Compare the initiator type of the order with the values.","required":["type","comparator","initiatorTypes"],"properties":{"type":{"type":"string","default":"BOOKING_INITIATOR_TYPE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"initiatorTypes":{"type":"array","description":"List of initiator types to compare.","minItems":1,"items":{"$ref":"#/components/schemas/InitiatorType"}}}}},"components/schemas/BookingType":{"id":"components/schemas/BookingType","kind":"json-schema","title":"BookingType","data":{"title":"BookingType","description":"What type of travel booking it is.","type":"string","enum":["AIR","HOTEL","CAR","RAIL","LIMO"],"example":"AIR"}},"components/schemas/BookingTypeV3Predicate":{"id":"components/schemas/BookingTypeV3Predicate","kind":"json-schema","title":"BookingTypeV3Predicate","data":{"title":"BookingTypeV3Predicate","type":"object","description":"Compare the booking type of the order with the values.","required":["type","comparator","bookingTypes"],"properties":{"type":{"type":"string","example":"BOOKING_TYPE","default":"BOOKING_TYPE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"bookingTypes":{"type":"array","description":"List of booking types to compare.","minItems":1,"items":{"$ref":"#/components/schemas/BookingType"}}}}},"components/schemas/BulkUploadResponse":{"id":"components/schemas/BulkUploadResponse","kind":"json-schema","title":"BulkUploadResponse","data":{"type":"object","title":"BulkUploadResponse","description":"Response to file upload which includes the ID of the task set to process it","required":["taskId"],"properties":{"taskId":{"description":"ID corresponding to the resulting upload task","type":"string","format":"uuid"}}}},"components/schemas/CaptureStep":{"id":"components/schemas/CaptureStep","kind":"json-schema","title":"CaptureStep","data":{"type":"string","title":"CaptureStep","description":"Point in the booking flow at which a custom field's answer is captured.","enum":["AT_CHECKOUT","AFTER_SEARCH_CLICK","BEFORE_SEARCH_CRITERIA"],"example":"AT_CHECKOUT"}},"components/schemas/CarItineraryContext":{"id":"components/schemas/CarItineraryContext","kind":"json-schema","title":"CarItineraryContext","data":{"type":"object","title":"CarItineraryContext","description":"Car Itinerary Context","required":["itineraryType","searchId","carId"],"properties":{"itineraryType":{"type":"string","description":"Type of itinerary","default":"CAR"},"searchId":{"type":"string","description":"Search key related to the booking"},"carId":{"type":"string","description":"Car ID of the selected car"}}}},"components/schemas/City":{"id":"components/schemas/City","kind":"json-schema","title":"City","data":{"type":"object","title":"City","description":"The city name and country.","required":["cityName","countryCode","administrativeDivCode"],"properties":{"cityName":{"type":"string","description":"The city name.","example":"Palo Alto"},"administrativeDivCode":{"type":"string","example":"CA"},"countryCode":{"type":"string","description":"Two letter country code.","example":"US"}}}},"components/schemas/CompanyRole":{"id":"components/schemas/CompanyRole","kind":"json-schema","title":"CompanyRole","data":{"type":"string","description":"Role of the company.","enum":["ORG","TMC","PARTNER_TMC","HR_FEED_CONNECTOR","TRIPS_DATA_CONNECTOR","GLOBAL"],"example":"ORG"}},"components/schemas/CostCenterPredicate":{"id":"components/schemas/CostCenterPredicate","kind":"json-schema","title":"CostCenterPredicate","data":{"type":"object","title":"CostCenterPredicate","description":"Compare the cost center of the traveler with the values.","required":["type","comparator","costCenters"],"properties":{"type":{"type":"string","default":"COST_CENTER"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"costCenters":{"type":"array","description":"List of cost center Ids to compare.","minItems":1,"items":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426655440000"}}}}},"components/schemas/CreateArmRequest":{"id":"components/schemas/CreateArmRequest","kind":"json-schema","title":"CreateArmRequest","data":{"type":"object","title":"CreateArmRequest","description":"A set of audiences along with their corresponding action.","required":["action","name"],"properties":{"name":{"type":"string","description":"Name of the arm.","example":"US Employee"},"audiences":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldAudience"},"default":[]},"action":{"$ref":"#/components/schemas/CustomFieldActionCreateRequest"}}}},"components/schemas/CreateArmResponse":{"id":"components/schemas/CreateArmResponse","kind":"json-schema","title":"CreateArmResponse","data":{"type":"object","title":"CreateArmResponse","description":"Arm Id and option group id if option source of arm is manual","required":["armId"],"properties":{"armId":{"type":"string","format":"uuid","description":"Arm id."},"optionGroupId":{"type":"string","format":"uuid","description":"Option group id if option source of arm is manual."}}}},"components/schemas/CreateCustomFieldRequestV3":{"id":"components/schemas/CreateCustomFieldRequestV3","kind":"json-schema","title":"CreateCustomFieldRequestV3","data":{"type":"object","title":"CreateCustomFieldRequestV3","description":"Request for creating a custom field.","required":["name"],"properties":{"name":{"type":"string","description":"Name of this field to be viewed by the user and consumed by mid-office systems.","example":"Air Reason Code"},"description":{"$ref":"#/components/schemas/DisplayText"},"includeLocations":{"type":"array","items":{"$ref":"#/components/schemas/IncludeLocation"}},"managementTags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"respondOnlyOnceLevel":{"$ref":"#/components/schemas/RespondOnlyOnceLevel"},"captureStep":{"$ref":"#/components/schemas/CaptureStep"}}}},"components/schemas/CreatedVia":{"id":"components/schemas/CreatedVia","kind":"json-schema","title":"CreatedViaEnum","data":{"title":"CreatedViaEnum","type":"string","description":"Indicates the source of creation of PNR, like SHELL, OBT, etc.","readOnly":true,"enum":["OFFLINE","OBT","SHELL","PASSIVE","API"]}},"components/schemas/CustomFieldAction":{"id":"components/schemas/CustomFieldAction","kind":"json-schema","title":"Action","data":{"type":"object","title":"Action","description":"An automatic or a user action to select one of the items as a response to the field.","discriminator":{"propertyName":"type","mapping":{"AUTO":"#/components/schemas/AutoOption","USER":"#/components/schemas/UserOption"}},"oneOf":[{"$ref":"#/components/schemas/AutoOption"},{"$ref":"#/components/schemas/UserOption"}]}},"components/schemas/CustomFieldActionCreateRequest":{"id":"components/schemas/CustomFieldActionCreateRequest","kind":"json-schema","title":"CustomFieldActionCreateRequest","data":{"type":"object","title":"CustomFieldActionCreateRequest","description":"An automatic or a user action to select one of the items as a response to the field.","discriminator":{"propertyName":"type","mapping":{"AUTO":"#/components/schemas/AutoOption","USER":"#/components/schemas/UserOptionCreateRequest"}},"oneOf":[{"$ref":"#/components/schemas/AutoOption"},{"$ref":"#/components/schemas/UserOptionCreateRequest"}]}},"components/schemas/CustomFieldAudience":{"id":"components/schemas/CustomFieldAudience","kind":"json-schema","title":"Audience","data":{"type":"object","title":"Audience","description":"A list of audiences for the custom field.","required":["name"],"properties":{"name":{"type":"string","description":"Name of the audience.","example":"US Employee"},"predicates":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldPredicate"},"default":[]}}}},"components/schemas/CustomFieldInfo":{"id":"components/schemas/CustomFieldInfo","kind":"json-schema","title":"CustomFieldInfo","data":{"allOf":[{"$ref":"#/components/schemas/CustomFieldV3"}],"title":"CustomFieldInfo","description":"Custom field info.","required":["definedAt","createdAt"],"properties":{"definedAt":{"$ref":"#/components/schemas/EntityLevel"},"enabled":{"type":"boolean","default":false,"description":"Boolean to enable or disable custom field.","example":true},"createdAt":{"$ref":"#/components/schemas/DateTimeOffset"},"parentInfos":{"type":"array","description":"Custom field information of a parent.","items":{"$ref":"#/components/schemas/Reference"}}}}},"components/schemas/CustomFieldOptionSource":{"id":"components/schemas/CustomFieldOptionSource","kind":"json-schema","title":"CustomFieldOptionSource","data":{"type":"object","title":"CustomFieldOptionSource","description":"Custom field option source.","discriminator":{"propertyName":"type","mapping":{"MANUAL":"#/components/schemas/CustomFieldV3ManualOptions","PROFILE":"#/components/schemas/Profile"}},"oneOf":[{"$ref":"#/components/schemas/CustomFieldV3ManualOptions"},{"$ref":"#/components/schemas/Profile"}]}},"components/schemas/CustomFieldOptionSourceCreateRequest":{"id":"components/schemas/CustomFieldOptionSourceCreateRequest","kind":"json-schema","title":"CustomFieldOptionSourceCreateRequest","data":{"type":"object","title":"CustomFieldOptionSourceCreateRequest","description":"Custom field option source.","discriminator":{"propertyName":"type","mapping":{"MANUAL":"#/components/schemas/CustomFieldV3ManualOptionsCreateRequest","PROFILE":"#/components/schemas/Profile"}},"oneOf":[{"$ref":"#/components/schemas/CustomFieldV3ManualOptionsCreateRequest"},{"$ref":"#/components/schemas/Profile"}]}},"components/schemas/CustomFieldPredicate":{"id":"components/schemas/CustomFieldPredicate","kind":"json-schema","title":"Predicate","data":{"type":"object","title":"Predicate","description":"One of the Predicates for the audience.","discriminator":{"propertyName":"type","mapping":{"BOOKING_TYPE":"#/components/schemas/BookingTypeV3Predicate","BOOKING_INITIATOR_TYPE":"#/components/schemas/BookingInitiatorTypePredicate","TRIP_USAGE_TYPE":"#/components/schemas/TripUsageTypePredicate","TRAVEL_REGION_TYPE":"#/components/schemas/TravelRegionTypePredicate","DESTINATION_COUNTRY":"#/components/schemas/DestinationCountryV3Predicate","DESTINATION_CITY":"#/components/schemas/DestinationCityPredicate","ORIGIN_CITY":"#/components/schemas/OriginCityPredicate","ORIGIN_COUNTRY":"#/components/schemas/OriginCountryPredicate","PREFERRED_VENDOR_TYPE":"#/components/schemas/PreferredVendorTypePredicate","SEARCH_COUNTRY":"#/components/schemas/SearchCountryV3Predicate","LEGAL_ENTITY":"#/components/schemas/LegalEntityV3Predicate","DEPARTMENT":"#/components/schemas/DepartmentPredicate","OFFICE":"#/components/schemas/OfficePredicate","COST_CENTER":"#/components/schemas/CostCenterPredicate","WORKER_TYPE":"#/components/schemas/WorkerTypeV3Predicate","TRAVELER_LEGAL_ENTITY_COUNTRY":"#/components/schemas/TravelerLegalEntityCountryV3Predicate","TRAVELER_PERSONA":"#/components/schemas/TravelerPersonaV3Predicate","TRAVELER_COUNTRY":"#/components/schemas/TravelerCountryPredicate","POLICY":"#/components/schemas/PolicyV3Predicate","CUSTOM_FIELD_RESPONSE":"#/components/schemas/CustomFieldResponsePredicate","BOOKING_FLOW_TYPE":"#/components/schemas/BookingFlowTypeV3Predicate","PNR_CREATION_PROCESS_TYPE":"#/components/schemas/PnrCreationProcessTypePredicate","POLICY_ACTION":"#/components/schemas/PolicyActionPredicate","SELECTED_FARE":"#/components/schemas/SelectedFarePredicate","PERSONAL_UPGRADE":"#/components/schemas/PersonalUpgradePredicate","REPORTING_FOP_TYPE":"#/components/schemas/ReportingFopTypePredicate","PNR_CREATION_REASON":"#/components/schemas/PnrCreationReasonPredicate","INLINE_QC_RULE_PREDICATE":"#/components/schemas/InlineQCRulePredicate","LLF_FARE":"#/components/schemas/LlfFarePredicate"}},"oneOf":[{"$ref":"#/components/schemas/BookingTypeV3Predicate"},{"$ref":"#/components/schemas/BookingInitiatorTypePredicate"},{"$ref":"#/components/schemas/TripUsageTypePredicate"},{"$ref":"#/components/schemas/TravelRegionTypePredicate"},{"$ref":"#/components/schemas/DestinationCountryV3Predicate"},{"$ref":"#/components/schemas/DestinationCityPredicate"},{"$ref":"#/components/schemas/OriginCityPredicate"},{"$ref":"#/components/schemas/OriginCountryPredicate"},{"$ref":"#/components/schemas/PreferredVendorTypePredicate"},{"$ref":"#/components/schemas/SearchCountryV3Predicate"},{"$ref":"#/components/schemas/LegalEntityV3Predicate"},{"$ref":"#/components/schemas/DepartmentPredicate"},{"$ref":"#/components/schemas/OfficePredicate"},{"$ref":"#/components/schemas/CostCenterPredicate"},{"$ref":"#/components/schemas/WorkerTypeV3Predicate"},{"$ref":"#/components/schemas/TravelerLegalEntityCountryV3Predicate"},{"$ref":"#/components/schemas/TravelerPersonaV3Predicate"},{"$ref":"#/components/schemas/TravelerCountryPredicate"},{"$ref":"#/components/schemas/PolicyV3Predicate"},{"$ref":"#/components/schemas/CustomFieldResponsePredicate"},{"$ref":"#/components/schemas/BookingFlowTypeV3Predicate"},{"$ref":"#/components/schemas/PnrCreationProcessTypePredicate"},{"$ref":"#/components/schemas/PolicyActionPredicate"},{"$ref":"#/components/schemas/SelectedFarePredicate"},{"$ref":"#/components/schemas/PersonalUpgradePredicate"},{"$ref":"#/components/schemas/ReportingFopTypePredicate"},{"$ref":"#/components/schemas/PnrCreationReasonPredicate"},{"$ref":"#/components/schemas/InlineQCRulePredicate"},{"$ref":"#/components/schemas/LlfFarePredicate"}]}},"components/schemas/CustomFieldResponsePredicate":{"id":"components/schemas/CustomFieldResponsePredicate","kind":"json-schema","title":"CustomFieldResponsePredicate","data":{"type":"object","title":"CustomFieldResponsePredicate","description":"Compare the custom field responses with the values.","required":["type","id","comparator","values"],"properties":{"type":{"type":"string","default":"CUSTOM_FIELD_RESPONSE"},"id":{"type":"string","format":"uuid"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"values":{"type":"array","minItems":1,"items":{"type":"string"}}}}},"components/schemas/CustomFieldResponsesContext":{"id":"components/schemas/CustomFieldResponsesContext","kind":"json-schema","title":"CustomFieldResponsesContext","data":{"type":"object","title":"CustomFieldResponsesContext","description":"Custom field responses which are already responded and auto added.","required":["customFieldResponses"],"properties":{"customFieldResponses":{"description":"A list of custom field responses, automated or user-entered.","type":"array","items":{"$ref":"#/components/schemas/CustomFieldV3Response"}}}}},"components/schemas/CustomFieldSelectedOption":{"id":"components/schemas/CustomFieldSelectedOption","kind":"json-schema","title":"CustomFieldSelectedOption","data":{"type":"object","title":"CustomFieldSelectedOption","description":"Selected response for the custom field.","required":["name"],"properties":{"name":{"type":"string","description":"Value of the selection"},"translatedName":{"type":"string","description":"Translated value of the selection"},"description":{"type":"string","description":"Description of the selection"},"translatedDescription":{"type":"string","description":"Translated description of the selection"},"additionalUserInput":{"type":"string","description":"Additional user input"},"additionalInfos":{"type":"array","description":"Actual values of the additional infos","items":{"type":"string"}},"additionalInfoConfigs":{"type":"array","description":"Additional info configs for the selected option","items":{"$ref":"#/components/schemas/AdditionalInfo"}},"optionId":{"type":"string","format":"uuid","description":"Id of the selected option; sent by clients, never returned"}}}},"components/schemas/CustomFieldV3":{"id":"components/schemas/CustomFieldV3","kind":"json-schema","title":"CustomFieldV3","data":{"type":"object","title":"CustomFieldV3","description":"Custom field.","required":["id","name"],"properties":{"id":{"type":"string","format":"uuid","description":"Custom field id."},"name":{"type":"string","description":"Name of this field to be viewed by the user and consumed by mid-office systems.","example":"Air Reason Code"},"description":{"$ref":"#/components/schemas/DisplayText"},"includeLocations":{"type":"array","items":{"$ref":"#/components/schemas/IncludeLocation"}},"managementTags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"respondOnlyOnceLevel":{"$ref":"#/components/schemas/RespondOnlyOnceLevel"},"captureStep":{"$ref":"#/components/schemas/CaptureStep"}}}},"components/schemas/CustomFieldV3ManualOptions":{"id":"components/schemas/CustomFieldV3ManualOptions","kind":"json-schema","title":"CustomFieldV3ManualOptions","data":{"type":"object","title":"CustomFieldV3ManualOptions","description":"Manual options.","required":["type"],"properties":{"type":{"type":"string","default":"MANUAL","example":"MANUAL"},"optionGroupId":{"type":"string","format":"uuid","description":"Identifier of options group","example":"f49d00fe-1eda-4304-ba79-a980f565281d"}}}},"components/schemas/CustomFieldV3ManualOptionsCreateRequest":{"id":"components/schemas/CustomFieldV3ManualOptionsCreateRequest","kind":"json-schema","title":"CustomFieldV3ManualOptionsCreateRequest","data":{"type":"object","title":"CustomFieldV3ManualOptionsCreateRequest","description":"Manual options.","required":["type"],"properties":{"type":{"type":"string","default":"MANUAL","example":"MANUAL"}}}},"components/schemas/CustomFieldV3Option":{"id":"components/schemas/CustomFieldV3Option","kind":"json-schema","title":"CustomFieldV3Option","data":{"type":"object","title":"CustomFieldV3Option","description":"Single option schema.","required":["name"],"properties":{"name":{"type":"string","description":"Unique name of the option","example":"XC"},"description":{"type":"string","description":"User understandable details for the given name","example":"Air exchange code"},"additionalInfos":{"type":"array","description":"Option level additional infos.","items":{"$ref":"#/components/schemas/AdditionalInfo"}},"translatedName":{"type":"string","description":"Translated name of the option, matching the users preferred language","example":"XC"},"translatedDescription":{"type":"string","description":"Translated description of the option, matching the users preferred language","example":"Código de intercambio de aire"},"optionId":{"type":"string","format":"uuid","readOnly":true,"description":"Server-assigned id of the option. Absent while the option has no id. On update it may be omitted, and a sent value is ignored (options are matched by name), but it must be a UUID.","example":"1b0f6c1e-3c2a-4d8e-9f10-2a3b4c5d6e7f"},"outcomes":{"$ref":"#/components/schemas/CustomFieldV3OptionOutcomes"}}}},"components/schemas/CustomFieldV3OptionOutcomes":{"id":"components/schemas/CustomFieldV3OptionOutcomes","kind":"json-schema","title":"CustomFieldV3OptionOutcomes","data":{"type":"object","title":"CustomFieldV3OptionOutcomes","description":"What selecting the option does. Returned only to users who can edit the custom fields of the company that owns the options (for an inherited field, the parent company). On update, omit it to keep the stored outcomes, or send an empty object to clear them.","properties":{"policyAssignment":{"$ref":"#/components/schemas/CustomFieldV3OptionPolicyAssignment"}}}},"components/schemas/CustomFieldV3OptionPolicyAssignment":{"id":"components/schemas/CustomFieldV3OptionPolicyAssignment","kind":"json-schema","title":"CustomFieldV3OptionPolicyAssignment","data":{"type":"object","title":"CustomFieldV3OptionPolicyAssignment","description":"Assigns a travel policy to the traveler who selects the option.","required":["policyId"],"properties":{"policyId":{"type":"string","description":"Id of an active policy of the company that owns the options.","example":"8774a66b-7493-4f41-908c-58ba81093947"}}}},"components/schemas/CustomFieldV3Response":{"id":"components/schemas/CustomFieldV3Response","kind":"json-schema","title":"CustomFieldV3Response","data":{"type":"object","title":"CustomFieldV3Response","description":"Custom field responses.","required":["fieldId","armId","selectedOptions"],"properties":{"fieldId":{"type":"string","format":"uuid","description":"Custom field id"},"fieldName":{"type":"string","description":"Name of the custom field"},"armId":{"type":"string","format":"uuid","description":"Arm id which is applicable"},"includeLocations":{"type":"array","items":{"$ref":"#/components/schemas/IncludeLocation"}},"selectedOptions":{"type":"array","description":"The list of options that are selected by user or auto populated.","items":{"$ref":"#/components/schemas/CustomFieldSelectedOption"}}}}},"components/schemas/CustomValueFormat":{"id":"components/schemas/CustomValueFormat","kind":"json-schema","title":"CustomValueFormat","data":{"type":"object","title":"CustomValueFormat","description":"Option format for custom value.","required":["isCustomValueAllowed"],"properties":{"isCustomValueAllowed":{"type":"boolean","description":"Indicates whether the user can enter a custom value.","default":false,"example":true},"userInputFormat":{"description":"Format details if user can enter a custom value.","$ref":"#/components/schemas/UserInputFormat"}}}},"components/schemas/DateTimeOffset":{"id":"components/schemas/DateTimeOffset","kind":"json-schema","title":"DateTimeOffset","data":{"title":"DateTimeOffset","description":"ISO8601 UTC Date Time","type":"object","required":["iso8601"],"properties":{"iso8601":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-4]):([0-5][0-9])(:([0-5][0-9]))?(Z|([+-](0[0-9]|1[0-4]):([0-5][0-9])))$","example":"2017-07-21T17:32Z"}}}},"components/schemas/DepartmentPredicate":{"id":"components/schemas/DepartmentPredicate","kind":"json-schema","title":"DepartmentPredicate","data":{"type":"object","title":"DepartmentPredicate","description":"Compare the department of the traveler with the values.","required":["type","comparator","departments"],"properties":{"type":{"type":"string","default":"DEPARTMENT"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"departments":{"type":"array","description":"List of department Ids to compare.","minItems":1,"items":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426655440000"}}}}},"components/schemas/DestinationCityPredicate":{"id":"components/schemas/DestinationCityPredicate","kind":"json-schema","title":"DestinationCityPredicate","data":{"type":"object","title":"DestinationCityPredicate","description":"Compare the destination city with the values.","required":["type","comparator","cities"],"properties":{"type":{"type":"string","default":"DESTINATION_CITY"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"cities":{"type":"array","description":"List of cities to compare.","minItems":1,"items":{"$ref":"#/components/schemas/City"}}}}},"components/schemas/DestinationCountryV3Predicate":{"id":"components/schemas/DestinationCountryV3Predicate","kind":"json-schema","title":"DestinationCountryV3Predicate","data":{"type":"object","title":"DestinationCountryV3Predicate","description":"Compare the destination country with the values.","required":["type","comparator","countries"],"properties":{"type":{"type":"string","default":"DESTINATION_COUNTRY"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"countries":{"type":"array","description":"List of 2-letter country codes to compare.","minItems":1,"items":{"type":"string","example":"US"}}}}},"components/schemas/DisplayText":{"id":"components/schemas/DisplayText","kind":"json-schema","title":"DisplayText","data":{"type":"object","title":"DisplayText","description":"User-facing description of the custom field.","required":["value"],"properties":{"value":{"type":"string","description":"Description of the custom field.","example":"This field will capture the reason for out of policy booking"}}}},"components/schemas/DynamicFare":{"id":"components/schemas/DynamicFare","kind":"json-schema","title":"DynamicFare","data":{"type":"object","title":"DynamicFare","description":"Dynamic Fare.","required":["type","fareType"],"properties":{"type":{"type":"string","default":"DYNAMIC_FARE"},"fareType":{"type":"string","description":"Fare type.","enum":["LLF"]}}}},"components/schemas/EntityId":{"id":"components/schemas/EntityId","kind":"json-schema","title":"EntityId","data":{"type":"object","description":"Identifier of an object","required":["id"],"properties":{"id":{"type":"string","format":"uuid","example":"b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"}}}},"components/schemas/EntityLevel":{"id":"components/schemas/EntityLevel","kind":"json-schema","title":"EntityLevel","data":{"type":"string","enum":["TMC_LEVEL","APPLICATION_LEVEL","COMPANY_LEVEL","LEGAL_ENTITY_LEVEL","USER_LEVEL"],"description":"Entity level for which this config needs to be set."}},"components/schemas/ErrorParameter":{"id":"components/schemas/ErrorParameter","kind":"json-schema","title":"ErrorParameter","data":{"type":"object","title":"ErrorParameter","description":"Error parameter","properties":{"name":{"type":"string","description":"Parameter name"},"value":{"type":"string","description":"Parameter value"}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"debugIdentifier":{"type":"string","description":"Link to debug the error internally."},"errorMessages":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code to identify the specific errors."},"message":{"type":"string","description":"Message containing details of error."},"errorParameters":{"type":"array","description":"Error message parameters.","items":{"$ref":"#/components/schemas/ErrorParameter"}},"errorDetail":{"type":"string","description":"More details about the error."}}}}}}},"components/schemas/Expression":{"id":"components/schemas/Expression","kind":"json-schema","title":"Expression","data":{"type":"object","title":"Expression","description":"Expression consisting of variables and constants which needs to be sent along with custom\nfield response.\n","required":["type","formatExpression"],"properties":{"type":{"type":"string","example":"EXPRESSION","default":"EXPRESSION"},"formatExpression":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expression must be of format : "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<any_text> ${expression} <any_text>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".The expression"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can consist of a combination of variables and mathematical operations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variable names must be same as VariableName Enum."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To define mathematical operations, the operation name should follow the format"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"math.<math_op>(arg1, arg2)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Both "},"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":" can be variables or constants."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The supported math operations (math_op) include: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add, mul, div, sub, min, and max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All keywords, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<math_op>, math, and var"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be written in lowercase."},"children":[]}]}]}],"example":"Result:  ${math.mul(LLF,5)}  ${ADD_COLLECT_AMOUNT}"},"variables":{"type":"array","description":"Reference names of the variables present in the expression.","deprecated":true,"x-sunset":"2026-07-01","items":{"$ref":"#/components/schemas/VariableName"}}}}},"components/schemas/FareValueV3":{"id":"components/schemas/FareValueV3","kind":"json-schema","title":"FareValueV3","data":{"type":"object","title":"FareValueV3","description":"Fare value which can either be static or dynamic.","discriminator":{"propertyName":"type","mapping":{"STATIC_FARE":"#/components/schemas/StaticFare","DYNAMIC_FARE":"#/components/schemas/DynamicFare"}},"oneOf":[{"$ref":"#/components/schemas/StaticFare"},{"$ref":"#/components/schemas/DynamicFare"}]}},"components/schemas/Field":{"id":"components/schemas/Field","kind":"json-schema","title":"Field","data":{"type":"object","title":"Field","description":"Custom Field information","required":["id"],"properties":{"id":{"type":"string","format":"uuid","description":"Custom field id."},"enabled":{"type":"boolean","default":false,"description":"Boolean to enable or disable custom field.","example":true}}}},"components/schemas/GetApplicableCustomFieldsRequest":{"id":"components/schemas/GetApplicableCustomFieldsRequest","kind":"json-schema","title":"GetApplicableCustomFieldsRequest","data":{"type":"object","title":"GetApplicableCustomFieldsRequest","description":"Request for fetching applicable custom fields.","required":["userId","bookingContext"],"properties":{"userId":{"type":"string","description":"User id for whom the custom fields must be applicable.","format":"uuid"},"bookingContext":{"$ref":"#/components/schemas/BookingContext"},"customFieldResponsesContext":{"$ref":"#/components/schemas/CustomFieldResponsesContext"}}}},"components/schemas/GetApplicableCustomFieldsResponse":{"id":"components/schemas/GetApplicableCustomFieldsResponse","kind":"json-schema","title":"GetApplicableCustomFieldsResponse","data":{"type":"object","title":"GetApplicableCustomFieldsResponse","description":"Response for fetching applicable custom fields.","required":["hasNewCustomFields","customFields"],"properties":{"hasNewCustomFields":{"type":"boolean","description":"Indicates if there are new custom fields that are applicable."},"customFields":{"description":"List of applicable custom fields including the ones which are already responded. It\nalso includes the selected response which user has already selected previously.\n","type":"array","items":{"$ref":"#/components/schemas/ApplicableCustomFieldV3"}}}}},"components/schemas/GetCustomFieldOptionListRequestV3":{"id":"components/schemas/GetCustomFieldOptionListRequestV3","kind":"json-schema","title":"GetCustomFieldOptionListRequestV3","data":{"type":"object","title":"GetCustomFieldOptionListRequestV3","description":"Request for fetching options for given custom field.","required":["paginationParams","fetchEffectiveAdditionalInfos"],"properties":{"paginationParams":{"$ref":"#/components/schemas/OffsetBasedPaginationRequestParams"},"nameSearchText":{"type":"string","description":"Only the option that contain the specified text in name will be returned."},"fetchEffectiveAdditionalInfos":{"type":"boolean","description":"Indicates whether the additional infos should be fetched for each option\nfrom arm level if individual option does not have definition of additional infos.\n","default":false}}}},"components/schemas/GetCustomFieldOptionListResponseV3":{"id":"components/schemas/GetCustomFieldOptionListResponseV3","kind":"json-schema","title":"GetCustomFieldOptionListResponseV3","data":{"type":"object","title":"GetCustomFieldOptionListResponseV3","description":"Response object for option list","required":["paginationParams"],"properties":{"paginationParams":{"$ref":"#/components/schemas/OffsetBasedPaginationResponseParams"},"options":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldV3Option"}}}}},"components/schemas/HotelItineraryContext":{"id":"components/schemas/HotelItineraryContext","kind":"json-schema","title":"HotelItineraryContext","data":{"type":"object","title":"HotelItineraryContext","description":"Hotel Itinerary Context","required":["itineraryType","bookingKey"],"properties":{"itineraryType":{"type":"string","description":"Type of itinerary","default":"HOTEL"},"bookingKey":{"type":"string","description":"Booking key of selected hotel room"}}}},"components/schemas/IncludeLocation":{"id":"components/schemas/IncludeLocation","kind":"json-schema","title":"IncludeLocation","data":{"type":"string","title":"IncludeLocation","description":"Various traveler notifications (e.g. emails) where the responses to this field should be included.","enum":["BOOKING_CONFIRMATION_EMAILS","APPROVAL_EMAILS","COMPANY_REPORTS","CONSOLIDATED_ITINERARY_EMAILS"],"example":"APPROVAL_EMAILS"}},"components/schemas/InitiatorType":{"id":"components/schemas/InitiatorType","kind":"json-schema","title":"InitiatorType","data":{"title":"InitiatorType","description":"Initiator type.","type":"string","enum":["AGENT","NON_AGENT"]}},"components/schemas/InlineQCFailureRule":{"id":"components/schemas/InlineQCFailureRule","kind":"json-schema","title":"InlineQCFailureRule","data":{"type":"object","title":"InlineQCFailureRule","description":"Inline QC failure rule","properties":{"ruleId":{"type":"string","description":"Rule Id"},"ruleType":{"$ref":"#/components/schemas/QcRuleType"}}}},"components/schemas/InlineQCRulePredicate":{"id":"components/schemas/InlineQCRulePredicate","kind":"json-schema","title":"InlineQCRulePredicate","data":{"type":"object","title":"InlineQCRulePredicate","description":"Compares the inline qc rule that failed with the values","required":["type","ruleTypes","comparator"],"properties":{"type":{"type":"string","default":"INLINE_QC_RULE_PREDICATE"},"ruleTypes":{"type":"array","items":{"$ref":"#/components/schemas/QcRuleType"}},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"}}}},"components/schemas/ItineraryContext":{"id":"components/schemas/ItineraryContext","kind":"json-schema","title":"ItineraryContext","data":{"type":"object","title":"ItineraryContext","description":"Itinerary Context for different types of itineraries","discriminator":{"propertyName":"itineraryType","mapping":{"AIR":"#/components/schemas/AirItineraryContext","HOTEL":"#/components/schemas/HotelItineraryContext","CAR":"#/components/schemas/CarItineraryContext","RAIL":"#/components/schemas/RailItineraryContext","LIMO":"#/components/schemas/LimoItineraryContext","OUTSIDE_BOOKING":"#/components/schemas/OutsideBookingContext","PNR":"#/components/schemas/PNRContext"}},"oneOf":[{"$ref":"#/components/schemas/AirItineraryContext"},{"$ref":"#/components/schemas/HotelItineraryContext"},{"$ref":"#/components/schemas/CarItineraryContext"},{"$ref":"#/components/schemas/RailItineraryContext"},{"$ref":"#/components/schemas/LimoItineraryContext"},{"$ref":"#/components/schemas/OutsideBookingContext"},{"$ref":"#/components/schemas/PNRContext"}]}},"components/schemas/LegalEntityV3Predicate":{"id":"components/schemas/LegalEntityV3Predicate","kind":"json-schema","title":"LegalEntityV3Predicate","data":{"type":"object","title":"LegalEntityV3Predicate","description":"Compare the traveler legal entity with the values.","required":["type","comparator","legalEntities"],"properties":{"type":{"type":"string","default":"LEGAL_ENTITY"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"legalEntities":{"type":"array","description":"List of legal entity Ids to compare.","minItems":1,"items":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426655440000"}}}}},"components/schemas/LimoItineraryContext":{"id":"components/schemas/LimoItineraryContext","kind":"json-schema","title":"LimoItineraryContext","data":{"type":"object","title":"LimoItineraryContext","description":"Limo Itinerary Context","required":["itineraryType","limoId"],"properties":{"itineraryType":{"type":"string","description":"Type of itinerary","default":"LIMO"},"limoId":{"type":"string","description":"Selected Limo option"}}}},"components/schemas/ListArmsFilter":{"id":"components/schemas/ListArmsFilter","kind":"json-schema","title":"ListArmsFilter","data":{"type":"object","title":"ListArmsFilter","properties":{"tripUsageTypes":{"type":"array","description":"List of trip usage types to filter ARMs.","items":{"$ref":"#/components/schemas/TripUsageType"}}}}},"components/schemas/ListArmsRequest":{"id":"components/schemas/ListArmsRequest","kind":"json-schema","title":"ListArmsRequest","data":{"type":"object","title":"ListArmsRequest","properties":{"searchText":{"type":"string","description":"Search text to filter the ARMs."},"filter":{"$ref":"#/components/schemas/ListArmsFilter"}}}},"components/schemas/ListArmsResponse":{"id":"components/schemas/ListArmsResponse","kind":"json-schema","title":"ListArmsResponse","data":{"type":"object","title":"ListArmsResponse","properties":{"arms":{"type":"array","items":{"$ref":"#/components/schemas/Arm"}}}}},"components/schemas/ListCustomFieldFilter":{"id":"components/schemas/ListCustomFieldFilter","kind":"json-schema","title":"ListCustomFieldFilter","data":{"type":"object","title":"ListCustomFieldFilter","properties":{"definedAtList":{"type":"array","description":"List of entity levels at which the custom field is defined.","items":{"$ref":"#/components/schemas/CompanyRole"}},"enabled":{"type":"boolean","description":"Boolean to enable or disable custom field.","example":true},"customFieldIds":{"type":"array","description":"Specific custom fields ids to filter.","items":{"type":"string","format":"uuid"}},"tripUsageTypes":{"type":"array","description":"List of trip usage types to filter custom fields.","items":{"$ref":"#/components/schemas/TripUsageType"}},"captureSteps":{"type":"array","description":"Filter by capture step (e.g. pre-search fields only). Empty means no filter.","items":{"$ref":"#/components/schemas/CaptureStep"}}}}},"components/schemas/ListCustomFieldRequestV3":{"id":"components/schemas/ListCustomFieldRequestV3","kind":"json-schema","title":"ListCustomFieldRequestV3","data":{"type":"object","title":"ListCustomFieldRequestV3","required":["paginationParams"],"properties":{"paginationParams":{"$ref":"#/components/schemas/OffsetBasedPaginationRequestParams"},"searchText":{"type":"string","description":"Search text to filter the custom fields."},"filter":{"$ref":"#/components/schemas/ListCustomFieldFilter"}}}},"components/schemas/ListCustomFieldResponseV3":{"id":"components/schemas/ListCustomFieldResponseV3","kind":"json-schema","title":"ListCustomFieldResponseV3 - paginationParams","data":{"type":"object","title":"ListCustomFieldResponseV3 - paginationParams","properties":{"paginationParams":{"$ref":"#/components/schemas/OffsetBasedPaginationResponseParams"},"fields":{"type":"array","description":"List of custom field info","items":{"$ref":"#/components/schemas/CustomFieldInfo"}}}}},"components/schemas/LlfFarePredicate":{"id":"components/schemas/LlfFarePredicate","kind":"json-schema","title":"LlfFarePredicate","data":{"type":"object","title":"LlfFarePredicate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compare the LLF (lowest logical fare) of the itinerary with the given amount. The LLF fare is zero when no LLF candidate exists for the itinerary, so a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GREATER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" check against zero is equivalent to \"an LLF alternative is present\"."},"children":[]}]}]}],"required":["type","comparator","money"],"properties":{"type":{"type":"string","default":"LLF_FARE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"money":{"$ref":"#/components/schemas/SimpleMoney"}}}},"components/schemas/NonRegexUserInputFormat":{"id":"components/schemas/NonRegexUserInputFormat","kind":"json-schema","title":"NonRegexUserInputFormat","data":{"type":"object","title":"NonRegexUserInputFormat","description":"Option format for user input without regex.","required":["type","allowedChars"],"properties":{"type":{"type":"string","default":"NON_REGEX","example":"NON_REGEX"},"allowedChars":{"type":"string","description":"The allowed characters for user input.","enum":["ALL","ALPHA_NUMERIC","NUMERIC"]},"maxLength":{"type":"integer","description":"The maximum length of any user entered text input.","example":10,"default":256,"maximum":256},"minLength":{"type":"integer","description":"The minimum length of any user entered text input.","example":1,"default":1,"minimum":1}}}},"components/schemas/OfficePredicate":{"id":"components/schemas/OfficePredicate","kind":"json-schema","title":"OfficePredicate","data":{"type":"object","title":"OfficePredicate","description":"Compare the office of the traveler with the values.","required":["type","comparator","offices"],"properties":{"type":{"type":"string","default":"OFFICE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"offices":{"type":"array","description":"List of office Ids to compare.","minItems":1,"items":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426655440000"}}}}},"components/schemas/OffsetBasedPaginationRequestParams":{"id":"components/schemas/OffsetBasedPaginationRequestParams","kind":"json-schema","title":"OffsetBasedPaginationRequestParams","data":{"type":"object","title":"OffsetBasedPaginationRequestParams","description":"Pagination parameters for requests.","properties":{"offset":{"type":"integer","format":"int32","description":"The starting index in the list from which results are returned. The value must be greater than or equal to 0.","default":0,"minimum":0},"limit":{"type":"integer","format":"int32","description":"Maximum number of results to be fetched.","minimum":1,"default":100}}}},"components/schemas/OffsetBasedPaginationResponseParams":{"id":"components/schemas/OffsetBasedPaginationResponseParams","kind":"json-schema","title":"PaginationResponseParams","data":{"type":"object","title":"PaginationResponseParams","description":"Pagination parameters for response.","required":["totalNumResults"],"properties":{"totalNumResults":{"type":"integer","format":"int32","description":"Total number of results."}}}},"components/schemas/OptionListSelectionFormat":{"id":"components/schemas/OptionListSelectionFormat","kind":"json-schema","title":"OptionListSelectionFormat","data":{"type":"object","title":"OptionListSelectionFormat","description":"Option format for list of options.","required":["type","optionListTypeFormat","customValueFormat"],"properties":{"type":{"type":"string","default":"OPTION_LIST","example":"OPTION_LIST"},"optionListTypeFormat":{"description":"Format details on what type of option list.","$ref":"#/components/schemas/OptionListTypeFormat"},"customValueFormat":{"description":"Format details if user can enter a custom value.","$ref":"#/components/schemas/CustomValueFormat"}}}},"components/schemas/OptionListTypeFormat":{"id":"components/schemas/OptionListTypeFormat","kind":"json-schema","title":"OptionListTypeFormat","data":{"type":"object","title":"OptionListTypeFormat","description":"Option format for select options.","required":["isMultiSelect"],"properties":{"isMultiSelect":{"type":"boolean","description":"Indicates whether the user can select multiple options.","default":false,"example":true},"isPctType":{"type":"boolean","description":"Indicates whether the user can select multiple options with percentage.","default":false,"example":true}}}},"components/schemas/OriginCityPredicate":{"id":"components/schemas/OriginCityPredicate","kind":"json-schema","title":"OriginCityPredicate","data":{"type":"object","title":"OriginCityPredicate","description":"Compare the origin city with the values.","required":["type","comparator","cities"],"properties":{"type":{"type":"string","default":"ORIGIN_CITY"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"cities":{"type":"array","description":"List of cities to compare.","minItems":1,"items":{"$ref":"#/components/schemas/City"}}}}},"components/schemas/OriginCountryPredicate":{"id":"components/schemas/OriginCountryPredicate","kind":"json-schema","title":"OriginCountryPredicate","data":{"type":"object","title":"OriginCountryPredicate","description":"Compare the destination country with the values.","required":["type","comparator","countries"],"properties":{"type":{"type":"string","default":"ORIGIN_COUNTRY"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"countries":{"type":"array","description":"List of 2-letter country codes to compare.","minItems":1,"items":{"type":"string","example":"US"}}}}},"components/schemas/OutsideBookingContext":{"id":"components/schemas/OutsideBookingContext","kind":"json-schema","title":"OutsideBookingContext","data":{"type":"object","title":"OutsideBookingContext","description":"Manual or Shell pnr context","deprecated":true,"x-sunset":"2027-07-01","required":["itineraryType","pnrId"],"properties":{"itineraryType":{"type":"string","description":"Type of itinerary","default":"OUTSIDE_BOOKING"},"pnrId":{"type":"string","description":"Pnr id for non-finalized shell or manual form pnr"}}}},"components/schemas/PNRContext":{"id":"components/schemas/PNRContext","kind":"json-schema","title":"PnrContext","data":{"type":"object","title":"PnrContext","description":"Pnr context","required":["itineraryType","pnrId"],"properties":{"itineraryType":{"type":"string","description":"Type of itinerary","default":"PNR"},"pnrId":{"type":"string","description":"Pnr id for the booking"}}}},"components/schemas/Persona":{"id":"components/schemas/Persona","kind":"json-schema","title":"Persona","data":{"type":"string","title":"Persona","description":"Persona of the user","enum":["UNKNOWN_PERSONA","EMPLOYEE","GUEST","PERSONAL","RELATIVE","ADHOC"],"example":"EMPLOYEE"}},"components/schemas/PersonalUpgradePredicate":{"id":"components/schemas/PersonalUpgradePredicate","kind":"json-schema","title":"PersonalUpgradePredicate","data":{"type":"object","title":"PersonalUpgradePredicate","description":"Evaluate if the booking is personal upgrade.","required":["type","comparator","isPersonalUpgrade"],"properties":{"type":{"type":"string","default":"PERSONAL_UPGRADE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"isPersonalUpgrade":{"type":"boolean","description":"Indicates whether the booking is personal upgrade or not."}}}},"components/schemas/PnrCreationProcessTypePredicate":{"id":"components/schemas/PnrCreationProcessTypePredicate","kind":"json-schema","title":"PnrCreationProcessTypePredicate","data":{"title":"PnrCreationProcessTypePredicate","type":"object","description":"Compare the pnr source type of the order with the values.","required":["type","comparator","pnrCreationProcessTypes"],"properties":{"type":{"type":"string","default":"PNR_CREATION_PROCESS_TYPE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"pnrCreationProcessTypes":{"type":"array","description":"List of pnr creation process types to compare.","minItems":1,"items":{"$ref":"#/components/schemas/CreatedVia"}}}}},"components/schemas/PnrCreationReasonPredicate":{"id":"components/schemas/PnrCreationReasonPredicate","kind":"json-schema","title":"PnrCreationReasonPredicate","data":{"allOf":[{"$ref":"#/components/schemas/StringSetPredicate"}],"title":"PnrCreationReasonPredicate","description":"Compare the pnr creation reason with the values.","required":["type"],"properties":{"type":{"type":"string","default":"PNR_CREATION_REASON"}}}},"components/schemas/PolicyActionPredicate":{"id":"components/schemas/PolicyActionPredicate","kind":"json-schema","title":"OutOfPolicyActionPredicate","data":{"title":"OutOfPolicyActionPredicate","type":"object","description":"Compare the policy action of the order with the values.","required":["type","isOutOfPolicy","comparator","actionTypes"],"properties":{"type":{"type":"string","default":"POLICY_ACTION"},"isOutOfPolicy":{"type":"boolean","description":"Indicates whether the policy is out of policy or not."},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"actionTypes":{"type":"array","description":"List of policy action types to compare.","minItems":1,"items":{"$ref":"#/components/schemas/PolicyActionType"}}}}},"components/schemas/PolicyActionType":{"id":"components/schemas/PolicyActionType","kind":"json-schema","title":"PolicyActionType","data":{"title":"PolicyActionType","description":"Policy action type.","type":"string","enum":["HARD_APPROVAL","SOFT_APPROVAL","PASSIVE_APPROVAL","SPLIT_PAYMENT","PREVENT_BOOKING"]}},"components/schemas/PolicyCondition":{"id":"components/schemas/PolicyCondition","kind":"json-schema","title":"PolicyCondition","data":{"type":"object","title":"PolicyCondition","description":"Policy condition.","discriminator":{"propertyName":"type","mapping":{"ANY_POLICY":"#/components/schemas/AnyPolicyPredicate","POLICY_ID":"#/components/schemas/PolicyIdPredicate"}},"oneOf":[{"$ref":"#/components/schemas/AnyPolicyPredicate"},{"$ref":"#/components/schemas/PolicyIdPredicate"}]}},"components/schemas/PolicyIdPredicate":{"id":"components/schemas/PolicyIdPredicate","kind":"json-schema","title":"PolicyPredicate","data":{"type":"object","title":"PolicyPredicate","description":"Predicate that compares policies based on a comparator.","required":["type","comparator","policyIds"],"properties":{"type":{"type":"string","example":"POLICY_ID","default":"POLICY_ID"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"policyIds":{"type":"array","description":"List of policy identifiers to compare.","minItems":1,"items":{"type":"string","format":"uuid","example":"f49d00fe-1eda-4304-ba79-a980f565281d"}}}}},"components/schemas/PolicyV3Predicate":{"id":"components/schemas/PolicyV3Predicate","kind":"json-schema","title":"PolicyV3Predicate","data":{"title":"PolicyV3Predicate","type":"object","description":"Compare the policy of the order with the values.","required":["type","isOutOfPolicy","condition"],"properties":{"type":{"type":"string","default":"POLICY"},"isOutOfPolicy":{"type":"boolean","description":"Indicates whether the policy is out of policy or not."},"condition":{"$ref":"#/components/schemas/PolicyCondition"}}}},"components/schemas/PreferredType":{"id":"components/schemas/PreferredType","kind":"json-schema","title":"PreferredType","data":{"title":"PreferredType","type":"string","description":"Preference type.","enum":["NOT_PREFERRED","COMPANY_PREFERRED","SPOTTERS_CHOICE","COMPANY_BLOCKED","TMC_PREFERRED"]}},"components/schemas/PreferredVendorTypePredicate":{"id":"components/schemas/PreferredVendorTypePredicate","kind":"json-schema","title":"PreferredVendorTypePredicate","data":{"type":"object","title":"PreferredVendorTypePredicate","description":"Compare the preferred type of the order with the values.","required":["type","comparator","preferredVendorTypes"],"properties":{"type":{"type":"string","default":"PREFERRED_VENDOR_TYPE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"preferredVendorTypes":{"type":"array","description":"List of preferred types to compare.","minItems":1,"items":{"$ref":"#/components/schemas/PreferredType"}}}}},"components/schemas/Profile":{"id":"components/schemas/Profile","kind":"json-schema","title":"Profile","data":{"type":"object","title":"Profile","description":"Different profile attribute to be used as a user selectable option group.","required":["type","attributeType"],"properties":{"type":{"type":"string","default":"PROFILE","example":"PROFILE"},"attributeType":{"$ref":"#/components/schemas/ProfileAttribute"},"attributeName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When type is COMPANY_DEFINED_USER_ATTRIBUTE, then the attribute_name"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contains the name of the attribute to provide the option values."},"children":[]}]}]}],"example":"ssAuthId"}}}},"components/schemas/ProfileAttribute":{"id":"components/schemas/ProfileAttribute","kind":"json-schema","title":"ProfileAttribute","data":{"type":"string","title":"ProfileAttribute","description":"The level at which the field will be stored.","enum":["LEGAL_ENTITY","OFFICE","COMPANY_DEFINED_USER_ATTRIBUTE","DEPARTMENT","COST_CENTER"],"example":"OFFICE"}},"components/schemas/QcRuleType":{"id":"components/schemas/QcRuleType","kind":"json-schema","title":"QcRuleType","data":{"type":"string","enum":["SEGMENT_GAP_RULE","OSI_REMARK","DUPLICATE_TICKET_RULE","VENDOR_CONFIRMATION_MISSING_RULE","LAST_NAME_MISPELLED_RULE","DUPLICATE_BOOKING_RULE","DATE_OF_BIRTH_RULE","SECURE_FLIGHT_INFO_RULE","PASSPORT_INFO_RULE","TICKET_LESS_CARRIER_RULE","VENDOR_CONFIRMED_STATUS_RULE","VALIDATING_CARRIER_RULE","OB_FEE_PRESENT_RULE","FRAUD_CITY_CHECK_RULE","FILE_FINISHING_RULE","FARE_THRESHOLD_MANUAL_VERIFICATION_CHECK_RULE","BLOCKED_AIRLINES_RULE","LAST_NAME_VALID_RULE","FRAUD_AIRPORT_MANUAL_VERIFICATION_CHECK_RULE","PNR_COMMISSION_RULE","DYNAMIC_OSI_REMARK_RULE","DYNAMIC_SSR_REMARK_RULE","COMMISSION_STALE_RULE","EXCHANGE_COMMISSION_CHECK_RULE","ADD_OTH_SEGMENT_RULE","IRD_MULTI_SEGMENT_RULE","FOP_CONDITIONS_CHECK_RULE","ADD_AGENCY_REMARKS","CHECK_MCO_RULE","OVERRIDE_VALIDATING_CARRIER_RULE","EDIT_PRICE_QUOTE_RULE","TRIP_CONTINUITY_RULE","PNR_PURCHASE_RULE","FRAUD_COUNTRY_AND_PNR_PURCHASE_RULE","FRAUD_AIRPORT_AND_PNR_PURCHASE_RULE","REMARK_CHECK_RULE","FLIGHT_METROPOLITAN_RULE","FLIGHT_LAYOVER_RULE","HOTEL_METROPOLITAN_RULE","TIME_CONTINUITY_RULE","CAR_METROPOLITAN_RULE","CAR_TIME_CONTINUITY_RULE","SSR_OSI_VALIDATION_RULE","PNR_QUEUING_RULE","GST_INFO_RULE","CONTACT_INFO_RULE","REDEEMING_MCO_RULE","REDEEMING_UNUSED_CREDIT_NAME_CHANGE_RULE","FARE_THRESHOLD_ON_BOOKING_OR_EXCHANGE_RULE","ADD_AGENCY_ADDRESS_RULE","BSP_EXCHANGE_VALID_EMD_RULE","HOTEL_CANCELLATION_RULE","ADD_ACCOUNTING_LINE_RULE","EXTERNAL_COMMISSIONS_PROCESSING_RULE","PRE_TICKETING_FARE_THRESHOLD_RULE"],"example":"FLIGHT_LAYOVER_RULE"}},"components/schemas/RailItineraryContext":{"id":"components/schemas/RailItineraryContext","kind":"json-schema","title":"CarItineraryContext","data":{"type":"object","title":"CarItineraryContext","description":"Car Itinerary Context","required":["itineraryType","searchKey"],"properties":{"itineraryType":{"type":"string","description":"Type of itinerary","default":"RAIL"},"searchKey":{"type":"string","description":"Search key related to the booking"}}}},"components/schemas/Reference":{"id":"components/schemas/Reference","kind":"json-schema","title":"Reference object containing uuid and name of the entity.","data":{"type":"object","title":"Reference object containing uuid and name of the entity.","description":"Reference of an entity","required":["id"],"properties":{"id":{"type":"string","format":"uuid","example":"b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"},"name":{"type":"string","example":"Name"}}}},"components/schemas/RegexUserInputFormat":{"id":"components/schemas/RegexUserInputFormat","kind":"json-schema","title":"RegexUserInputFormat","data":{"type":"object","title":"RegexUserInputFormat","description":"Option format for user input with regex.","required":["type","regex"],"properties":{"type":{"type":"string","default":"REGEX","example":"REGEX"},"regex":{"type":"string","description":"Regex to validate the user input.","example":"^[a-zA-Z0-9]*$"}}}},"components/schemas/ReorderCustomFieldsRequest":{"id":"components/schemas/ReorderCustomFieldsRequest","kind":"json-schema","title":"ReorderCustomFieldsRequest","data":{"type":"object","title":"ReorderCustomFieldsRequest","required":["targetFieldId","direction","fieldIdsToMove"],"properties":{"targetFieldId":{"type":"string","format":"uuid","description":"The custom field id of the target position to which the fields needs to be moved."},"direction":{"type":"string","description":"This is used to determine the direction of movement - before or after the target field","enum":["BEFORE","AFTER"]},"fieldIdsToMove":{"type":"array","minItems":1,"description":"Custom field ids who have to be moved below or above the target custom field.","items":{"type":"string","format":"uuid","description":"Custom field id."}}}}},"components/schemas/ReportingFopType":{"id":"components/schemas/ReportingFopType","kind":"json-schema","title":"ReportingFopType","data":{"title":"ReportingFopType","description":"Reporting fop type.","type":"string","enum":["UATP","VIRTUAL_CARD","DIRECT_BILLING"]}},"components/schemas/ReportingFopTypePredicate":{"id":"components/schemas/ReportingFopTypePredicate","kind":"json-schema","title":"ReportingFopTypePredicate","data":{"type":"object","title":"ReportingFopTypePredicate","description":"Compare the reporting fop type with the values.","required":["type","comparator","reportingFopTypes"],"properties":{"type":{"type":"string","default":"REPORTING_FOP_TYPE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"reportingFopTypes":{"type":"array","description":"List of reporting fop types to compare.","items":{"$ref":"#/components/schemas/ReportingFopType"}}}}},"components/schemas/RespondOnlyOnceLevel":{"id":"components/schemas/RespondOnlyOnceLevel","kind":"json-schema","title":"RespondOnlyOnceLevel","data":{"type":"string","description":"User can respond this field only once at given level.","enum":["TRIP"],"example":"TRIP"}},"components/schemas/RuleEngineComparator":{"id":"components/schemas/RuleEngineComparator","kind":"json-schema","title":"RuleEngineComparator","data":{"type":"string","description":"The comparator to compare rule values.","enum":["IN","ANY_IN","NOT_IN_ANY","NOT_IN","EQUAL_GREATER","EQUAL_LESSER","GREATER","LESSER","CONTAINS","EQ","NOT_EQ"]}},"components/schemas/SearchCountryV3Predicate":{"id":"components/schemas/SearchCountryV3Predicate","kind":"json-schema","title":"SearchCountryV3Predicate","data":{"type":"object","title":"SearchCountryV3Predicate","description":"Compare the search country with the values.","required":["type","comparator","countries"],"properties":{"type":{"type":"string","default":"SEARCH_COUNTRY"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"countries":{"type":"array","description":"List of 2 letter country codes to compare.","minItems":1,"items":{"type":"string","example":"US"}}}}},"components/schemas/SelectedFarePredicate":{"id":"components/schemas/SelectedFarePredicate","kind":"json-schema","title":"SelectedFarePredicate","data":{"title":"SelectedFarePredicate","type":"object","description":"Compare the itinerary fare of the order with the values.","required":["type","comparator","value"],"properties":{"type":{"type":"string","default":"SELECTED_FARE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"value":{"$ref":"#/components/schemas/FareValueV3"}}}},"components/schemas/SelectionFormat":{"id":"components/schemas/SelectionFormat","kind":"json-schema","title":"SelectionFormat","data":{"type":"object","title":"SelectionFormat","description":"Option Selection format","discriminator":{"propertyName":"type","mapping":{"OPTION_LIST":"#/components/schemas/OptionListSelectionFormat","TEXT_INPUT":"#/components/schemas/TextInputSelectionFormat"}},"oneOf":[{"$ref":"#/components/schemas/OptionListSelectionFormat"},{"$ref":"#/components/schemas/TextInputSelectionFormat"}]}},"components/schemas/SimpleMoney":{"id":"components/schemas/SimpleMoney","kind":"json-schema","title":"SimpleMoney","data":{"type":"object","title":"SimpleMoney","description":"Money object containing just amount and currency code.","required":["amount","currencyCode"],"properties":{"amount":{"type":"number","format":"double","description":"Amount","example":510},"currencyCode":{"type":"string","description":"The 3-letter currency code defined in ISO 4217.","example":"GBP"}}}},"components/schemas/StaticFare":{"id":"components/schemas/StaticFare","kind":"json-schema","title":"StaticFare","data":{"type":"object","title":"StaticFare","description":"Static fare.","required":["type","money"],"properties":{"type":{"type":"string","default":"STATIC_FARE"},"money":{"$ref":"#/components/schemas/SimpleMoney"}}}},"components/schemas/StringSetPredicate":{"id":"components/schemas/StringSetPredicate","kind":"json-schema","title":"StringSetPredicate","data":{"type":"object","title":"StringSetPredicate","description":"Base predicate for comparing entity attributes.","required":["comparator","values"],"properties":{"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"values":{"type":"array","description":"List of values to compare.","minItems":1,"items":{"type":"string"}}}}},"components/schemas/Tag":{"id":"components/schemas/Tag","kind":"json-schema","title":"Tag","data":{"type":"object","title":"Tag","description":"These tags are to be used for management purposes to encode the source and attributes \nneeded to identify the fields for given management page.\n","required":["key","value"],"properties":{"key":{"type":"string","description":"The name or identifier of the tag.","example":"OOP Reason Code"},"value":{"type":"string","description":"The display name of the tag, used as an alternative on the management page.","example":"Out of Policy Code"}}}},"components/schemas/TextInputSelectionFormat":{"id":"components/schemas/TextInputSelectionFormat","kind":"json-schema","title":"TextInputSelectionFormat","data":{"type":"object","title":"TextInputSelectionFormat","description":"Option format for text input.","required":["type","userInputFormat"],"properties":{"type":{"type":"string","default":"TEXT_INPUT","example":"TEXT_INPUT"},"userInputFormat":{"description":"Format details of the text user can input.","$ref":"#/components/schemas/UserInputFormat"}}}},"components/schemas/TravelRegionType":{"id":"components/schemas/TravelRegionType","kind":"json-schema","title":"TravelRegionType","data":{"type":"string","title":"TravelRegionType","description":"Travel region Type","enum":["DOMESTIC","INTERNATIONAL"],"example":"DOMESTIC"}},"components/schemas/TravelRegionTypePredicate":{"id":"components/schemas/TravelRegionTypePredicate","kind":"json-schema","title":"TravelRegionTypePredicate","data":{"type":"object","title":"TravelRegionTypePredicate","description":"Compare the travel region type of the trip with the given values.","required":["type","comparator","travelRegionTypes"],"properties":{"type":{"type":"string","default":"TRAVEL_REGION_TYPE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"travelRegionTypes":{"type":"array","description":"List of travel region types to compare.","items":{"$ref":"#/components/schemas/TravelRegionType"}}}}},"components/schemas/TravelerCountryPredicate":{"id":"components/schemas/TravelerCountryPredicate","kind":"json-schema","title":"TravelerCountryPredicate","data":{"type":"object","title":"TravelerCountryPredicate","description":"Compare the country of the traveler with the values.","required":["type","comparator","countryCodes"],"properties":{"type":{"type":"string","default":"TRAVELER_COUNTRY"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"countryCodes":{"type":"array","description":"List of traveler country codes to compare.","items":{"type":"string","example":"US"}}}}},"components/schemas/TravelerLegalEntityCountryV3Predicate":{"id":"components/schemas/TravelerLegalEntityCountryV3Predicate","kind":"json-schema","title":"TravelerLegalEntityCountryV3Predicate","data":{"type":"object","title":"TravelerLegalEntityCountryV3Predicate","description":"Compare the legal entity country of the traveler with the values.","required":["type","comparator","countryCodes"],"properties":{"type":{"type":"string","default":"TRAVELER_LEGAL_ENTITY_COUNTRY"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"countryCodes":{"type":"array","description":"List of legal entity country codes to compare.","items":{"type":"string","example":"US"}}}}},"components/schemas/TravelerPersonaV3Predicate":{"id":"components/schemas/TravelerPersonaV3Predicate","kind":"json-schema","title":"TravelerPersonaV3Predicate","data":{"type":"object","title":"TravelerPersonaV3Predicate","description":"Compare the persona of the traveler with the values.","required":["type","comparator","personas"],"properties":{"type":{"type":"string","default":"TRAVELER_PERSONA"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"personas":{"type":"array","description":"List of personas to compare","minItems":1,"items":{"$ref":"#/components/schemas/Persona"}}}}},"components/schemas/TripUsageType":{"id":"components/schemas/TripUsageType","kind":"json-schema","title":"TripUsageType","data":{"title":"TripUsageType","description":"Trip usage type.","type":"string","enum":["STANDARD","EVENT"]}},"components/schemas/TripUsageTypePredicate":{"id":"components/schemas/TripUsageTypePredicate","kind":"json-schema","title":"TripUsageTypePredicate","data":{"type":"object","title":"TripUsageTypePredicate","description":"Compare the trip usage type of the order with the values.","required":["type","comparator","tripUsageTypes"],"properties":{"type":{"type":"string","default":"TRIP_USAGE_TYPE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"tripUsageTypes":{"type":"array","description":"List of trip usage types to compare.","minItems":1,"items":{"$ref":"#/components/schemas/TripUsageType"}}}}},"components/schemas/UpdateCustomFieldOptionGroupRequestV3":{"id":"components/schemas/UpdateCustomFieldOptionGroupRequestV3","kind":"json-schema","title":"UpdateCustomFieldOptionGroupRequestV3","data":{"type":"object","title":"UpdateCustomFieldOptionGroupRequestV3","description":"Request for updating a custom field options group.","properties":{"toUpdate":{"type":"array","description":"Array of option to insert or update. Any existing option with same name will be updated and if there is no exiting item having same name as specified, then a new option will be inserted.","items":{"$ref":"#/components/schemas/CustomFieldV3Option"}},"toDelete":{"type":"array","description":"Array of option that need to be deleted","items":{"type":"string","example":"XC"}}}}},"components/schemas/UpdateCustomFieldStatusRequest":{"id":"components/schemas/UpdateCustomFieldStatusRequest","kind":"json-schema","title":"UpdateCustomFieldStatusRequest","data":{"type":"object","title":"UpdateCustomFieldStatusRequest","properties":{"fieldsToUpdate":{"type":"array","description":"Custom fields whose status has to be updated","items":{"$ref":"#/components/schemas/Field"},"default":[]},"fieldsToDelete":{"type":"array","description":"The field ids for deletion.","items":{"type":"string","format":"uuid"},"default":[]}}}},"components/schemas/UserInputFormat":{"id":"components/schemas/UserInputFormat","kind":"json-schema","title":"UserInputFormat","data":{"type":"object","title":"UserInputFormat","description":"Option format for user input.","discriminator":{"propertyName":"type","mapping":{"NON_REGEX":"#/components/schemas/NonRegexUserInputFormat","REGEX":"#/components/schemas/RegexUserInputFormat"}},"oneOf":[{"$ref":"#/components/schemas/NonRegexUserInputFormat"},{"$ref":"#/components/schemas/RegexUserInputFormat"}]}},"components/schemas/UserOption":{"id":"components/schemas/UserOption","kind":"json-schema","title":"UserOption","data":{"type":"object","title":"UserOption","description":"An option representing a user selectable option for a custom field.","required":["format","type"],"x-ignoreBreakingChanges":["UserOption->preSelectedOptions"],"properties":{"type":{"type":"string","example":"USER","default":"USER"},"name":{"type":"string","description":"Name of the option.","example":"US employee codes"},"required":{"type":"boolean","description":"Indicates whether the user can opt not to select any of the options.","default":false,"example":true},"format":{"$ref":"#/components/schemas/SelectionFormat"},"additionalInfos":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalInfo"}},"userOptionSource":{"$ref":"#/components/schemas/CustomFieldOptionSource"},"preSelectedOptions":{"readOnly":true,"description":"Pre-selected options for the user.","type":"array","items":{"$ref":"#/components/schemas/CustomFieldSelectedOption"}},"readOnly":{"type":"boolean","readOnly":true,"description":"Indicates whether the user can change the pre-selected options.","default":false,"example":true},"hidden":{"type":"boolean","description":"Whether this code will be hidden to the user.","example":true,"default":false}}}},"components/schemas/UserOptionCreateRequest":{"id":"components/schemas/UserOptionCreateRequest","kind":"json-schema","title":"UserOptionCreateRequest","data":{"type":"object","title":"UserOptionCreateRequest","description":"An option representing a user selectable option for a custom field.","required":["format","type"],"properties":{"type":{"type":"string","example":"USER","default":"USER"},"name":{"type":"string","description":"Name of the option.","example":"US employee codes"},"required":{"type":"boolean","description":"Indicates whether the user can opt not to select any of the options.","default":false,"example":true},"format":{"$ref":"#/components/schemas/SelectionFormat"},"additionalInfos":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalInfo"}},"userOptionSource":{"$ref":"#/components/schemas/CustomFieldOptionSourceCreateRequest"},"preSelectedOptions":{"readOnly":true,"description":"Pre-selected options for the user.","type":"array","items":{"$ref":"#/components/schemas/CustomFieldV3Option"}},"readOnly":{"type":"boolean","readOnly":true,"description":"Indicates whether the user can change the pre-selected options.","default":false,"example":true}}}},"components/schemas/Variable":{"id":"components/schemas/Variable","kind":"json-schema","title":"Variable","data":{"type":"object","title":"Variable","description":"Variable defining the additional value to be sent along with custom field response.","required":["type","name"],"properties":{"type":{"type":"string","example":"VARIABLE","default":"VARIABLE"},"name":{"$ref":"#/components/schemas/VariableName"}}}},"components/schemas/VariableName":{"id":"components/schemas/VariableName","kind":"json-schema","title":"VariableName","data":{"type":"string","title":"VariableName","description":"Name of the variable.","enum":["PUBLISHED_FARE","LLF","ADD_COLLECT_AMOUNT","SELECTED_FARE","SPLIT_PAYMENT_FARE"],"example":"LLF","x-ignoreBreakingChanges":["VariableName->ADD_COLLECT_AMOUNT","VariableName->SELECTED_FARE","VariableName->SPLIT_PAYMENT_FARE"]}},"components/schemas/WorkerType":{"id":"components/schemas/WorkerType","kind":"json-schema","title":"WorkerType","data":{"type":"string","description":"The type of worker.","enum":["EMPLOYEE","CONTINGENT","SEASONAL","INTERN","GUEST"],"example":"EMPLOYEE","x-enumValidFrom":{"GUEST":"2025-06-03"}}},"components/schemas/WorkerTypeV3Predicate":{"id":"components/schemas/WorkerTypeV3Predicate","kind":"json-schema","title":"WorkerTypeV3Predicate","data":{"type":"object","title":"WorkerTypeV3Predicate","description":"Compare the worker type with the values.","required":["type","comparator","workerTypes"],"properties":{"type":{"type":"string","default":"WORKER_TYPE"},"comparator":{"$ref":"#/components/schemas/RuleEngineComparator"},"workerTypes":{"type":"array","description":"List of worker types to compare.","minItems":1,"items":{"$ref":"#/components/schemas/WorkerType"}}}}},"schema_0":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CompanyRole"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File of bulk records"}}},"id":"schema_2"}},"exampleStore":{},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/customfieldapi","isMockServer":true,"description":"Spotnana mock server"}],"specType":"openapi"},"options":{"codeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"}]},"feedback":{"hide":true,"settings":{"label":""}},"mockServer":{"url":"/_mock/openapi/customfieldapi","position":"last","description":"Spotnana mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/CustomFieldApi.json?download"},{"url":"/_bundle/openapi/CustomFieldApi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Custom Field API"}},"baseSlug":"/openapi/customfieldapi","routesMapping":{}}