Jump to

• Request
• Response

Get a work order status

get

/crmRestApi/resources/11.13.18.05/svcWorkOrderStatuses/{WoStatusNumber}

Request

Path Parameters

• WoStatusNumber(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• CategoryDisplaySequence: integer (int64)
  Title: Category Display Order

  Read Only: true

  The ordering sequence number for the status category.
• CategoryName: string
  Title: Status Category

  Read Only: true

  Maximum Length: 80

  The status category name which indicates the category the status belongs to.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the status was created.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the status.
• DisplaySequence: integer (int64)
  Title: Display Order

  The ordering sequence number for the status.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: false

  Indicates whether the status is enabled.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the status was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user or source who last updated the status.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RuleDescription: string
  Title: Status Rule

  Read Only: true

  Maximum Length: 240

  The description of the rule that will be applied to the status.
• SeedDataFlag: boolean
  Title: Seed Data

  Read Only: true

  Indicates if this is a seed data record.
• StatusName: string
  Title: Status

  Maximum Length: 80

  The display value that identifies the status.
• translations: array Work Order Status Translations
  Title: Work Order Status Translations

  The status translations resource is used to view, create, update and delete the translatable values for the status resource.
• TypeName: string
  Title: Type of Work Order

  Read Only: true

  Maximum Length: 80

  The type of the service work order.
• UseCancelProcessFlag: boolean
  Title: Enable Cancel Process

  Maximum Length: 1

  Default Value: false

  Indicates whether the service work order status should initiate the cancel part process.
• WoIntegrationCd: string
  Title: Type of Work Order Code

  Maximum Length: 30

  Indicates the type of service work order this status is associated with.
• WoStatusCatCd: string
  Title: Status Category Code

  Maximum Length: 30

  The category code of the status.
• WoStatusCd: string
  Title: Status Code

  Maximum Length: 30

  The status code used to track the progress and state of the work order throughout its lifecycle.
• WoStatusId: integer (int64)
  Title: Status ID

  Read Only: true

  The unique identifier of the status.
• WoStatusNumber: string
  Title: Status Number

  Maximum Length: 30

  The alternate unique identifier of the status.

{
    "type":"object",
    "properties":{
        "CategoryDisplaySequence":{
            "title":"Category Display Order",
            "type":"integer",
            "description":"The ordering sequence number for the status category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Status Category",
            "maxLength":80,
            "type":"string",
            "description":"The status category name which indicates the category the status belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the status was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the status.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Order",
            "type":"integer",
            "description":"The ordering sequence number for the status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the status is enabled.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the status was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user or source who last updated the status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleDescription":{
            "title":"Status Rule",
            "maxLength":240,
            "type":"string",
            "description":"The description of the rule that will be applied to the status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SeedDataFlag":{
            "title":"Seed Data",
            "type":"boolean",
            "description":"Indicates if this is a seed data record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusName":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The display value that identifies the status.",
            "nullable":true,
            "x-queryable":true
        },
        "TypeName":{
            "title":"Type of Work Order",
            "maxLength":80,
            "type":"string",
            "description":"The type of the service work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "WoIntegrationCd"
                ]
            }
        },
        "UseCancelProcessFlag":{
            "title":"Enable Cancel Process",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service work order status should initiate the cancel part process.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WoIntegrationCd":{
            "title":"Type of Work Order Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of service work order this status is associated with.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WoStatusCatCd":{
            "title":"Status Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The category code of the status.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WoStatusCd":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code used to track the progress and state of the work order throughout its lifecycle.",
            "nullable":false,
            "x-queryable":true
        },
        "WoStatusId":{
            "title":"Status ID",
            "type":"integer",
            "description":"The unique identifier of the status.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WoStatusNumber":{
            "title":"Status Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the status.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "translations":{
            "title":"Work Order Status Translations",
            "type":"array",
            "description":"The status translations resource is used to view, create, update and delete the translatable values for the status resource.",
            "items":{
                "$ref":"#/components/schemas/svcWorkOrderStatuses-translations-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 : Work Order Status Translations

Type: array

Title: Work Order Status Translations

The status translations resource is used to view, create, update and delete the translatable values for the status resource.

Show Source

• Array of: object svcWorkOrderStatuses-translations-item-response

{
    "title":"Work Order Status Translations",
    "type":"array",
    "description":"The status translations resource is used to view, create, update and delete the translatable values for the status resource.",
    "items":{
        "$ref":"#/components/schemas/svcWorkOrderStatuses-translations-item-response"
    }
}

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

Nested Schema : svcWorkOrderStatuses-translations-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the translatable status was created.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the translatable status.
• Language: string
  Title: Language

  Maximum Length: 4

  The language to which the status is translated.
• LanguageCode: string
  Title: Language Code

  Read Only: true

  Maximum Length: 4

  The unique code of the language code into which the status is translated.
• LanguageDisplayName: string
  Title: Language Name

  Read Only: true

  Maximum Length: 255

  The display language into which the status is translated.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the translatable status was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The source who last updated the translatable status.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RuleDescription: string
  Title: Status Rule

  Maximum Length: 240

  The description of the rule that will be applied to the translatable status.
• SourceLang: string
  Title: Source Language

  Maximum Length: 4

  The source language from which the status is translated.
• SourceLangCode: string
  Title: Language Code

  Read Only: true

  Maximum Length: 4

  The source language code from which the status is translated.
• SourceLangDisplayName: string
  Title: Language Name

  Read Only: true

  Maximum Length: 255

  The source display language from which the status is translated.
• StatusName: string
  Title: Status

  Maximum Length: 80

  The translated display value that identifies the status. This is a foreign key to the status table.
• WoStatusId: integer (int64)
  Title: Status ID

  The unique identifier of the translated status.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the translatable status.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the translatable status was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the translatable status.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "Language":{
            "title":"Language",
            "maxLength":4,
            "type":"string",
            "description":"The language to which the status is translated.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LanguageCode":{
            "title":"Language Code",
            "maxLength":4,
            "type":"string",
            "description":"The unique code of the language code into which the status is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LanguageDisplayName":{
            "title":"Language Name",
            "maxLength":255,
            "type":"string",
            "description":"The display language into which the status is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the translatable status was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The source who last updated the translatable status.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "RuleDescription":{
            "title":"Status Rule",
            "maxLength":240,
            "type":"string",
            "description":"The description of the rule that will be applied to the translatable status.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "SourceLang":{
            "title":"Source Language",
            "maxLength":4,
            "type":"string",
            "description":"The source language from which the status is translated.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "SourceLangCode":{
            "title":"Language Code",
            "maxLength":4,
            "type":"string",
            "description":"The source language code from which the status is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLangDisplayName":{
            "title":"Language Name",
            "maxLength":255,
            "type":"string",
            "description":"The source display language from which the status is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusName":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The translated display value that identifies the status. This is a foreign key to the status table.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "WoStatusId":{
            "title":"Status ID",
            "type":"integer",
            "description":"The unique identifier of the translated status.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:OA_TRANSLATABLE":"false"
            },
            "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"
    }
}

Links

WoIntegrationCdLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_WO_INT_CD

The following properties are defined on the LOV link relation:

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

WoStatusCategoryCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_WO_STATUS_CAT_CD

The following properties are defined on the LOV link relation:

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

translations

Operation: /crmRestApi/resources/11.13.18.05/svcWorkOrderStatuses/{WoStatusNumber}/child/translations

Parameters:

• WoStatusNumber: $request.path.WoStatusNumber

The status translations resource is used to view, create, update and delete the translatable values for the status resource.

Back to Top