Webresources.update - PipelinerCRM

Modifies Webresource or Webresources with given id(s)

Request

Path Params

string <uuid>

required

ID of Webresource to update

Query Params

validation-level

integer <int32>

optional

Specify validation level of Webresource on update. Use them as bit mask: 0 - validate each field on entity,
2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,
16 - allows to set entity on deleted relationship.

Body Params application/json

display_param

enum<string>

optional

Bit Flag field, with limited combination of integer values.

Options:
FullScreen = 1 (0b01)
DoNotShowIfEmpty = 2 (0b10)

Allowed values:

Example:

entity

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

name

string

optional

Name of the entity and its default text representation.

Example:

string

request_method

enum<integer>

optional

Integer enum value: 1 - Get, 2 - Post

Allowed values:

Example:

url

string

optional

URL - HTTP address.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

{
    "display_param": 1,
    "entity": "string",
    "name": "string",
    "request_method": 1,
    "url": "string",
    "revision": 1
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting Webresource

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Webresource)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

has_draft

boolean

required

Set to True if draft for entity exists and can be published

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

display_param

enum<string>

required

Bit Flag field, with limited combination of integer values.

Options:
FullScreen = 1 (0b01)
DoNotShowIfEmpty = 2 (0b10)

Allowed values:

Example:

entity

string

required

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

name

string

required

Name of the entity and its default text representation.

Example:

string

request_method

enum<integer>

optional

Integer enum value: 1 - Get, 2 - Post

Allowed values:

Example:

url

string

optional

URL - HTTP address.

Example:

string

is_published

boolean

read-onlyoptional

Example:

false

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "has_draft": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "display_param": 1,
        "entity": "string",
        "name": "string",
        "request_method": 1,
        "url": "string",
        "is_published": false,
        "revision": 1
    }
}

🟠404Record Not Found

🔴500Server Error