Jump to

• Request
• Response

Update a work order area configuration

patch

/crmRestApi/resources/11.13.18.05/woAreaConfigurations/{ConfigNumber}

Request

Path Parameters

• ConfigNumber(required): string
  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: string
  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: string
  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

• ConnectionCd: string
  Title: Connection Code

  Maximum Length: 30

  Value that uniquely identifies the field service connection associated to this work order area configuration.
• EnabledFlag: boolean
  Title: Enable Work Order Area Retrieval

  Maximum Length: 1

  Default Value: false

  Indicates if the work order area configuration is enabled.
• FitnessFormulaSkill: integer (int32)
  Title: Work Skill

  Default Value: 0

  The work skill fitness filter used to retrieve the list of work order areas.
• FitnessFormulaWoZone: integer (int32)
  Title: Work Zone

  Default Value: 0

  The work zone fitness filter used to retrieve the list of work order areas.
• NumberRecordsToReturn: integer (int32)
  Title: Number of Records to Return

  Default Value: 10

  Indicates the number of records to return in the work order area list of values.

{
    "type":"object",
    "properties":{
        "ConnectionCd":{
            "title":"Connection Code",
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the field service connection associated to this work order area configuration.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enable Work Order Area Retrieval",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the work order area configuration is enabled.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FitnessFormulaSkill":{
            "title":"Work Skill",
            "type":"integer",
            "description":"The work skill fitness filter used to retrieve the list of work order areas.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":3
            }
        },
        "FitnessFormulaWoZone":{
            "title":"Work Zone",
            "type":"integer",
            "description":"The work zone fitness filter used to retrieve the list of work order areas.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":3
            }
        },
        "NumberRecordsToReturn":{
            "title":"Number of Records to Return",
            "type":"integer",
            "description":"Indicates the number of records to return in the work order area list of values.",
            "format":"int32",
            "nullable":false,
            "default":10,
            "x-hints":{
                "precision":3
            }
        }
    }
}

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 : woAreaConfigurations-item-response

Type: object

Show Source

• ConfigId: integer (int64)
  Read Only: true

  The unique identifier of the work order area configuration.
• ConfigNumber: string
  Title: Configuration Number

  Maximum Length: 30

  Value that uniquely identifies the alternate unique identifier of the work order area configuration. This value can be system-generated, or can be configured. The default configuration is CDRM-0000000000.
• ConnectionCd: string
  Title: Connection Code

  Maximum Length: 30

  Value that uniquely identifies the field service connection associated to this work order area configuration.
• ConnectionName: string
  Title: Connection Name

  Read Only: true

  Maximum Length: 80

  The user defined name for the field service connection associated to this work order area configuration.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the work order area configuration was created.
• EnabledFlag: boolean
  Title: Enable Work Order Area Retrieval

  Maximum Length: 1

  Default Value: false

  Indicates if the work order area configuration is enabled.
• FitnessFormulaSkill: integer (int32)
  Title: Work Skill

  Default Value: 0

  The work skill fitness filter used to retrieve the list of work order areas.
• FitnessFormulaWoZone: integer (int32)
  Title: Work Zone

  Default Value: 0

  The work zone fitness filter used to retrieve the list of work order areas.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Indicates the date and time of last update for the work order area configuration.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the work order area configuration.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberRecordsToReturn: integer (int32)
  Title: Number of Records to Return

  Default Value: 10

  Indicates the number of records to return in the work order area list of values.

{
    "type":"object",
    "properties":{
        "ConfigId":{
            "type":"integer",
            "description":"The unique identifier of the work order area configuration.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ConfigNumber":{
            "title":"Configuration Number",
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the alternate unique identifier of the work order area configuration. This value can be system-generated, or can be configured. The default configuration is CDRM-0000000000.",
            "nullable":false,
            "x-queryable":true
        },
        "ConnectionCd":{
            "title":"Connection Code",
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the field service connection associated to this work order area configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "ConnectionName":{
            "title":"Connection Name",
            "maxLength":80,
            "type":"string",
            "description":"The user defined name for the field service connection associated to this work order area configuration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ConnectionCd"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the work order area configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the work order area configuration was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enable Work Order Area Retrieval",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the work order area configuration is enabled.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FitnessFormulaSkill":{
            "title":"Work Skill",
            "type":"integer",
            "description":"The work skill fitness filter used to retrieve the list of work order areas.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "FitnessFormulaWoZone":{
            "title":"Work Zone",
            "type":"integer",
            "description":"The work zone fitness filter used to retrieve the list of work order areas.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time of last update for the work order area configuration.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the work order area configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberRecordsToReturn":{
            "title":"Number of Records to Return",
            "type":"integer",
            "description":"Indicates the number of records to return in the work order area list of values.",
            "format":"int32",
            "nullable":false,
            "default":10,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Back to Top