Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
qfq
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
typo3
qfq
Commits
2df0545a
Commit
2df0545a
authored
7 years ago
by
Carsten Rose
Browse files
Options
Downloads
Patches
Plain Diff
PROTOCOL.md: extend doc for record lock API
parent
a423c13a
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/PROTOCOL.md
+38
-1
38 additions, 1 deletion
doc/PROTOCOL.md
with
38 additions
and
1 deletion
doc/PROTOCOL.md
+
38
−
1
View file @
2df0545a
...
...
@@ -318,7 +318,7 @@ Server Response
: The response contains a [Minimal Response].
### Record
(s)
delete
### Record delete
Request the deletion of the record identified by the SIP. The SIP might contain a SIP_TABLE and/or a SIP_FORM.
If both are specified, SIP_FORM will be taken. With SIP_FORM, the tableName is derived from the form.
...
...
@@ -353,6 +353,43 @@ URL Parameters
Server Response
: The response contains at least a [Minimal Response]. In addition, a [Typeahead dict],
### Record lock
Request, extend or release a lock for a record, identified by the SIP. The SIP contain a SIP_FORM and a SIP_R (record id).
To detect record change at time of 'record lock' or 'record save', a MD5 hash is provided from the server
and needs to pass back to dirty.php as well.
Request
: api/dirty.php
Request Method
: GET
URL Parameters
:
`s=<SIP>`
(form, r)
:
`action=lock`
,
`action=extend`
,
`action=release>`
:
`recordHashMd5=<value of hidden form element 'recordHashMd5'>`
Server Response
: The response contains an [Lock Response].
### Lock Response
Asynchronous request (read AJAX) initiated by the Client receive a
JSON Response from the server (extended [Minimal Response]) containing:
{
"status": "success"|"error"|"conflict"|"conflict_allow_force",
"message": "<message>"
}
`status`
indicates how the request has been fullfiled by the server.
On
`"success"`
, the Client display nothing to the user.
On one of
`"error"|"conflict"|"conflict_allow_force"`
the Client must display
`"<message>"`
to the user.
On
`"conflict"`
the Client opens the alert as modal dialog (user can't change anything on the form) with a 'reload current
form' button.
On
`"conflict_allow_force"`
the Client opens the alert non-modal (default).
## Glossary
SIP
...
...
This diff is collapsed.
Click to expand it.
Carsten Rose
@carsten.rose
mentioned in merge request
!14 (merged)
·
7 years ago
mentioned in merge request
!14 (merged)
mentioned in merge request !14
Toggle commit list
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment