Jump to

• Request
• Response

Update a survey configuration

patch

/crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}

Request

Path Parameters

• ConfigId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• configurationAttributes: array Survey Configuration Attributes
  Title: Survey Configuration Attributes

  The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.
• Description: string
  Title: Survey Configuration Description

  Maximum Length: 1000

  The description of the survey configuration.
• Name: string
  Title: Survey Configuration Name

  Maximum Length: 400

  The name of the survey configuration.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey configuration.
• VendorCd: string
  Title: Survey Product

  Maximum Length: 30

  This is the product-specific code for the survey. For example, SURVEY_MONKEY.

{
    "type":"object",
    "properties":{
        "configurationAttributes":{
            "title":"Survey Configuration Attributes",
            "type":"array",
            "description":"The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.",
            "items":{
                "$ref":"#/components/schemas/surveyConfigurations-configurationAttributes-item-patch-request"
            }
        },
        "Description":{
            "title":"Survey Configuration Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the survey configuration.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey configuration.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "VendorCd":{
            "title":"Survey Product",
            "maxLength":"30",
            "type":"string",
            "description":"This is the product-specific code for the survey. For example, SURVEY_MONKEY.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Name":{
            "title":"Survey Configuration Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the survey configuration.",
            "nullable":false
        }
    }
}

Nested Schema : Survey Configuration Attributes

Type: array

Title: Survey Configuration Attributes

The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.

Show Source

• Array of: object surveyConfigurations-configurationAttributes-item-patch-request

{
    "title":"Survey Configuration Attributes",
    "type":"array",
    "description":"The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.",
    "items":{
        "$ref":"#/components/schemas/surveyConfigurations-configurationAttributes-item-patch-request"
    }
}

Nested Schema : surveyConfigurations-configurationAttributes-item-patch-request

Type: object

Show Source

• AttributeCd: string
  Title: Survey Configuration Attribute Code

  Maximum Length: 30

  This is the type of the survey configuration attribute. For example, SURVEY_LIST_API, or SURVEY_DETAIL_API.
• AttributeValue: string
  Title: Survey Configuration Attribute Value

  Maximum Length: 4000

  This is the value of the survey configuration attribute.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey configuration attribute.

{
    "type":"object",
    "properties":{
        "AttributeValue":{
            "title":"Survey Configuration Attribute Value",
            "maxLength":"4000",
            "type":"string",
            "description":"This is the value of the survey configuration attribute.",
            "nullable":false
        },
        "AttributeCd":{
            "title":"Survey Configuration Attribute Code",
            "maxLength":"30",
            "type":"string",
            "description":"This is the type of the survey configuration attribute. For example, SURVEY_LIST_API, or SURVEY_DETAIL_API.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey configuration attribute.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : surveyConfigurations-item-response

Type: object

Show Source

• ConfigId: integer (int64)
  Title: Survey Configuration ID

  Read Only: true

  The unique identifier of the survey configuration.
• configurationAttributes: array Survey Configuration Attributes
  Title: Survey Configuration Attributes

  The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the survey configuration.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the survey configuration was created.
• Description: string
  Title: Survey Configuration Description

  Maximum Length: 1000

  The description of the survey configuration.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the survey configuration was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the survey configuration.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the survey configuration.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Survey Configuration Name

  Maximum Length: 400

  The name of the survey configuration.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey configuration.
• ProductName: string
  Title: Survey Product

  Read Only: true

  Maximum Length: 80

  The survey product which a particular survey belongs to, such as Survey Monkey.
• SurveyConfigNumber: string
  Maximum Length: 30

  This number is an auto-generated unique number that's used for import and export of Survey Configurations.
• VendorCd: string
  Title: Survey Product

  Maximum Length: 30

  This is the product-specific code for the survey. For example, SURVEY_MONKEY.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the survey configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the survey configuration was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the survey configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Survey Configuration Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the survey configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductName":{
            "title":"Survey Product",
            "maxLength":"80",
            "type":"string",
            "description":"The survey product which a particular survey belongs to, such as Survey Monkey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorCd":{
            "title":"Survey Product",
            "maxLength":"30",
            "type":"string",
            "description":"This is the product-specific code for the survey. For example, SURVEY_MONKEY.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SurveyConfigNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"This number is an auto-generated unique number that's used for import and export of Survey Configurations.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "title":"Survey Configuration Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the survey configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey configuration.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "configurationAttributes":{
            "title":"Survey Configuration Attributes",
            "type":"array",
            "description":"The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.",
            "items":{
                "$ref":"#/components/schemas/surveyConfigurations-configurationAttributes-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConfigId":{
            "title":"Survey Configuration ID",
            "type":"integer",
            "description":"The unique identifier of the survey configuration.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the survey configuration was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the survey configuration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Survey Configuration Attributes

Type: array

Title: Survey Configuration Attributes

The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.

Show Source

• Array of: object surveyConfigurations-configurationAttributes-item-response

{
    "title":"Survey Configuration Attributes",
    "type":"array",
    "description":"The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.",
    "items":{
        "$ref":"#/components/schemas/surveyConfigurations-configurationAttributes-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : surveyConfigurations-configurationAttributes-item-response

Type: object

Show Source

• AttributeCd: string
  Title: Survey Configuration Attribute Code

  Maximum Length: 30

  This is the type of the survey configuration attribute. For example, SURVEY_LIST_API, or SURVEY_DETAIL_API.
• AttributeValue: string
  Title: Survey Configuration Attribute Value

  Maximum Length: 4000

  This is the value of the survey configuration attribute.
• ConfigAttrId: integer (int64)
  Title: Survey Configuration Attribute ID

  Read Only: true

  This is the identifier of the survey configuration attribute.
• ConfigId: integer (int64)
  Title: Survey Configuration ID

  Read Only: true

  This is the unique identifier of the survey configuration attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the survey configuration attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the survey configuration attribute was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the survey configuration attribute was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the survey configuration attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the survey configuration attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey configuration attribute.
• SurveyConfigNumber: string
  Read Only: true

  Maximum Length: 30

  This number is an auto-generated unique number that's used for import and export of Survey Configuration Attributes.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the survey configuration attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the survey configuration attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValue":{
            "title":"Survey Configuration Attribute Value",
            "maxLength":"4000",
            "type":"string",
            "description":"This is the value of the survey configuration attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the survey configuration attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfigAttrId":{
            "title":"Survey Configuration Attribute ID",
            "type":"integer",
            "description":"This is the identifier of the survey configuration attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey configuration attribute.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConfigId":{
            "title":"Survey Configuration ID",
            "type":"integer",
            "description":"This is the unique identifier of the survey configuration attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeCd":{
            "title":"Survey Configuration Attribute Code",
            "maxLength":"30",
            "type":"string",
            "description":"This is the type of the survey configuration attribute. For example, SURVEY_LIST_API, or SURVEY_DETAIL_API.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the survey configuration attribute was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the survey configuration attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SurveyConfigNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"This number is an auto-generated unique number that's used for import and export of Survey Configuration Attributes.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

VendorCodeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SURVEY_VENDOR_TYPE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: VendorCd; Target Attribute: LookupCode
• Display Attribute: Meaning

configurationAttributes

Operation: /crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}/child/configurationAttributes

Parameters:

• ConfigId: $request.path.ConfigId

The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.

Back to Top