Variable sys_ws_query_parameterConst

Type Declaration

• ReadonlyallowWebServiceAccess: true

• Readonlyattributes: { update_synch: true }

• Readonlydisplay: "name"

• Readonlyextends: "sys_metadata"

• Readonlylabel: "Scripted REST Query Parameter"

• Readonlyname: "sys_ws_query_parameter"

• Readonlyschema: {
      example_value: Typed<
          string,
          {
              attributes: { edge_encryption_enabled: true };
              label: [
                  {
                      hint: "An example of a valid value for this query parameter. Appears in API documentation.";
                      label: "Example value";
                      plural: "Example values";
                  },
              ];
              maxLength: 255;
          },
      >;
      name: Typed<
          string,
          {
              attributes: { edge_encryption_enabled: true };
              label: [
                  {
                      hint: "The name of the query parameter. Appears in API documentation.";
                      label: "Query parameter name";
                      plural: "Query parameter names";
                  },
              ];
              mandatory: true;
          },
      >;
      required: Typed<
          boolean,
          {
              label: [
                  {
                      hint: "Require this query parameter in all requests to the resource";
                      label: "Is required";
                      plural: "Is required";
                  },
              ];
              maxLength: 30;
          },
      >;
      short_description: Typed<
          string,
          {
              attributes: { edge_encryption_enabled: true };
              label: [
                  {
                      hint: "The description of the query parameter. Appears in API documentation.";
                      label: "Short description";
                      plural: "Short descriptions";
                  },
              ];
              maxLength: 80;
          },
      >;
      web_service_definition: Typed<
          | string
          | Record<"sys_ws_definition">
          | ExplicitKey<"sys_ws_definition">
          | TableBrand<"sys_ws_definition">,
          {
              attributes: { encode_utf8: false };
              cascadeRule: "delete";
              label: [
                  {
                      hint: "The API this query parameter belongs to";
                      label: "API definition";
                      plural: "API definitions";
                  },
              ];
              mandatory: true;
              referenceTable: "sys_ws_definition";
          },
      >;
  }

• ReadonlytextIndex: true